CrudKit

https://github.com/suleymanozev/crudkit
Admin
CrudKit is a convention-based CRUD framework for .NET that automatically generates REST endpoints...
Tokens:82,164
Snippets:708
Trust Score:7.5
License:MIT
Update:6 months ago
Show doc for...
Tokens:
Raw
### Full Configuration Example

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/reference/configuration-options.md

An example demonstrating how to configure CrudKit with various options.

```APIDOC
## Full Configuration Example

```csharp
builder.Services.AddCrudKitEf<AppDbContext>();
builder.Services.AddCrudKit(opts =>
{
    opts.DefaultPageSize = 25;
    opts.MaxPageSize = 100;
    opts.ApiPrefix = "/api";
    opts.BulkLimit = 1_000;
    opts.EnableIdempotency = true;

    opts.UseAuditTrail()
        .EnableAuditFailedOperations();

    opts.UseExport();
    opts.MaxExportRows = 50_000;
    opts.UseImport();
    opts.MaxImportFileSize = 10 * 1024 * 1024; // 10 MB
    opts.UseEnumAsString();
    opts.UseDomainEvents();

    opts.UseMultiTenancy()
        .ResolveTenantFromHeader("X-Tenant-Id")
        .RejectUnresolvedTenant()
        .CrossTenantPolicy(p =>
        {
            p.Allow("superadmin");
            p.AllowReadOnly("support");
        });

    opts.UseGlobalHook<SearchIndexHook>();
    opts.UseGlobalHook<CacheInvalidationHook>();

    opts.ScanModulesFromAssembly = typeof(Program).Assembly;
});
```
```

--------------------------------

### Query Pagination Example

Source: https://github.com/suleymanozev/crudkit/blob/main/docs/API-REFERENCE.md

Example of pagination parameters and the resulting response structure.

```text
GET /api/products?page=2&per_page=25
```

```json
{
  "total": 143,
  "page": 2,
  "per_page": 25,
  "data": [ ... ]
}
```

--------------------------------

### Query Includes Example

Source: https://github.com/suleymanozev/crudkit/blob/main/docs/API-REFERENCE.md

Example of eager loading navigation properties via query string.

```text
GET /api/orders?include=lines
```

--------------------------------

### Start Local Development Server

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/README.md

Starts a local development server for live preview. Changes are reflected without server restart.

```bash
yarn start
```

--------------------------------

### Development Setup Commands

Source: https://github.com/suleymanozev/crudkit/blob/main/CONTRIBUTING.md

Commands to clone the repository, build the solution, and execute tests.

```bash
# Clone
git clone https://github.com/suleymanozev/CrudKit.git
cd CrudKit

# Build
dotnet build CrudKit.slnx

# Run tests
dotnet test CrudKit.slnx

# Run integration tests with PostgreSQL (requires Docker)
dotnet test tests/CrudKit.Integration.Tests/
```

--------------------------------

### Full Program.cs Example for Multi-Tenancy

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/features/multi-tenant.md

A complete example of configuring CrudKit with multi-tenancy in your application's Program.cs file. This includes setting up the DbContext, current user, and CrudKit options.

```csharp
var builder = WebApplication.CreateBuilder(args);

builder.Services.AddDbContext<AppDbContext>(opts =>
    opts.UseSqlite("Data Source=app.db"));

builder.Services.AddScoped<ICurrentUser, JwtCurrentUser>();

builder.Services.AddCrudKitEf<AppDbContext>();
builder.Services.AddCrudKit(opts =>
{
    opts.UseMultiTenancy()
        .ResolveTenantFromClaim("tenant_id")
        .RejectUnresolvedTenant()
        .CrossTenantPolicy(p => p.Allow("superadmin"));
});

var app = builder.Build();
app.UseCrudKit(); // auto-registers all [CrudEntity] types
app.Run();
```

--------------------------------

### Install Dependencies with Yarn

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/README.md

Installs project dependencies using Yarn. Run this command after cloning the repository.

```bash
yarn
```

--------------------------------

### Query Sorting Examples

Source: https://github.com/suleymanozev/crudkit/blob/main/docs/API-REFERENCE.md

Examples of sorting endpoints using the sort parameter.

```text
GET /api/products?sort=price          # ascending
GET /api/products?sort=-created_at    # descending (prefix with -)
```

--------------------------------

### Configure Domain Events Setup

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/features/domain-events.md

Configure domain event usage with options for default setup, assembly scanning, or a custom dispatcher.

```csharp
opts.UseDomainEvents();
// or with assembly scanning:
opts.UseDomainEvents(cfg => cfg.ScanHandlersFromAssembly(typeof(Program).Assembly));
// or with custom dispatcher:
opts.UseDomainEvents<MyCustomDispatcher>();
```

--------------------------------

### Define Entities and Aggregate Roots

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/getting-started/entity-hierarchy.md

Examples of defining entities with default Guid keys, custom key types, and aggregate roots with domain event support.

```csharp
// Guid key (default)
public class Currency : Entity { }
public class Product : AuditableEntity { }
public class Order : FullAuditableEntity { }
public class Invoice : FullAuditableEntityWithUser<AppUser> { }

// Aggregate roots (with domain event support)
public class Invoice : FullAuditableAggregateRoot { }
public class Payment : AuditableAggregateRoot { }

// Custom key types
public class LegacyProduct : AuditableEntity<long> { }
public class LegacyOrder : FullAuditableEntityWithUser<long, AppUser, int> { }
```

--------------------------------

### Entity Hierarchy and Examples

Source: https://github.com/suleymanozev/crudkit/blob/main/README.md

Demonstrates the entity hierarchy provided by CRUDKit and example entity definitions.

```APIDOC
## Entity Hierarchy

CRUDKit provides a hierarchy of base entity classes to simplify common patterns:

- **Entity**: Provides a `Guid Id`.
- **Entity<TKey>**: Allows for custom key types (e.g., `long`, `int`).
- **AuditableEntity**: Extends `Entity` with `CreatedAt` and `UpdatedAt` timestamps.
- **AuditableEntityWithUser<TUser>**: Adds `CreatedById` and `UpdatedById`, automatically populated from `ICurrentUser`.
- **FullAuditableEntity**: Extends `AuditableEntity` with `DeletedAt` for soft deletion (`ISoftDeletable`).
- **FullAuditableEntityWithUser<TUser>**: Combines user tracking and soft deletion.
- **AggregateRoot**: Includes domain event support (`IHasDomainEvents`).
- **AuditableAggregateRoot**: Adds timestamps to `AggregateRoot`.
- **AuditableAggregateRootWithUser<TUser>**: Adds user tracking to `AuditableAggregateRoot`.
- **FullAuditableAggregateRoot**: Adds soft deletion to `AggregateRoot`.
- **FullAuditableAggregateRootWithUser<TUser>**: Combines user tracking, soft deletion, and domain events.

## Example Entities

```csharp
// Lookup table — Guid Id only
public class Currency : Entity { }

// Timestamps + soft delete
[CrudEntity]
[RequireAuth]
[AuthorizeOperation("Delete", "admin")]
public class Order : FullAuditableEntity
{
    public string CustomerName { get; set; } = string.Empty;
    public decimal Total { get; set; }
}

// Timestamps + user tracking + soft delete
[CrudEntity]
[RequireRole("admin")]
public class Invoice : FullAuditableEntityWithUser<AppUser>
{
    public string InvoiceNumber { get; set; } = string.Empty;
    public decimal Total { get; set; }
}

// Custom key type
public class LegacyProduct : AuditableEntity<long> { }
public class LegacyOrder : FullAuditableEntityWithUser<long, AppUser, int> { }
```
```

--------------------------------

### Install CrudKit Packages

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/getting-started/quick-start.md

Add the necessary NuGet packages to your .NET project.

```bash
dotnet add package CrudKit.Api
dotnet add package CrudKit.EntityFrameworkCore
```

--------------------------------

### Entity Setup for Import/Export

Source: https://github.com/suleymanozev/crudkit/blob/main/docs/API-REFERENCE.md

Decorate entity classes with attributes to control import and export behavior.

```csharp
[CrudEntity(Resource = "products")]
[Exportable]
[Importable]
public class Product : AuditableEntity
{
    public string Name { get; set; } = string.Empty;
    public decimal Price { get; set; }

    [NotExportable]
    public string InternalCode { get; set; } = string.Empty;

    [NotImportable]
    public string CalculatedField { get; set; } = string.Empty;
}
```

--------------------------------

### Define Entity with Guid Key

Source: https://github.com/suleymanozev/crudkit/blob/main/docs/API-REFERENCE.md

Example of defining a simple entity using the default Guid key.

```csharp
public class Currency : Entity { }
```

--------------------------------

### Install CrudKit.Identity Package

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/guides/identity.md

Add the CrudKit.Identity package to your project using the .NET CLI.

```bash
dotnet add package CrudKit.Identity
```

--------------------------------

### Request with Tenant Header (Bash)

Source: https://context7.com/suleymanozev/crudkit/llms.txt

Example of making a request with a tenant ID specified in the `X-Tenant-Id` header.

```bash
# Request with tenant header
curl "http://localhost:5000/api/orders" \
  -H "X-Tenant-Id: acme-corp"
```

--------------------------------

### Get by ID Response and Error Handling

Source: https://context7.com/suleymanozev/crudkit/llms.txt

Example of a successful retrieval and a 404 Not Found error response.

```json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Smartphone Pro",
  "price": 999.99,
  "sku": "PHONE-001",
  "description": "Latest smartphone model",
  "createdAt": "2026-01-15T10:30:00Z",
  "updatedAt": "2026-01-15T10:30:00Z"
}
```

```json
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Product with ID '550e8400-e29b-41d4-a716-446655440000' was not found."
}
```

--------------------------------

### Implement Multi-Tenant Entities

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/reference/interfaces.md

Examples of implementing multi-tenancy with string keys, navigation properties, or typed keys.

```csharp
// Basic — string TenantId
public class Order : FullAuditableEntity, IMultiTenant
{
    public string TenantId { get; set; } = string.Empty;
}

// With navigation property
public class Order : FullAuditableEntity, IMultiTenant<Tenant>
{
    public string TenantId { get; set; } = string.Empty;
    public Tenant? Tenant { get; set; }
}

// With typed tenant key
public class Order : FullAuditableEntity, IMultiTenant<Tenant, Guid>
{
    public Guid TenantId { get; set; }
    public Tenant? Tenant { get; set; }
}
```

--------------------------------

### Query Filtering Examples

Source: https://github.com/suleymanozev/crudkit/blob/main/docs/API-REFERENCE.md

Examples of filtering endpoints using query string parameters.

```text
GET /api/products?name=like:phone
GET /api/products?price=gte:100
GET /api/products?status=in:active,pending
GET /api/products?deletedAt=null
GET /api/products?price=gt:10&price=lt:500
```

--------------------------------

### Entity Hierarchy Examples

Source: https://github.com/suleymanozev/crudkit/blob/main/README.md

Demonstrates various entity inheritance patterns including simple lookups, auditable entities, and custom key types.

```csharp
// Lookup table — Guid Id only
public class Currency : Entity { }

// Timestamps + soft delete
[CrudEntity]
[RequireAuth]
[AuthorizeOperation("Delete", "admin")]
public class Order : FullAuditableEntity
{
    public string CustomerName { get; set; } = string.Empty;
    public decimal Total { get; set; }
}

// Timestamps + user tracking + soft delete
[CrudEntity]
[RequireRole("admin")]
public class Invoice : FullAuditableEntityWithUser<AppUser>
{
    public string InvoiceNumber { get; set; } = string.Empty;
    public decimal Total { get; set; }
}

// Custom key type
public class LegacyProduct : AuditableEntity<long> { }
public class LegacyOrder : FullAuditableEntityWithUser<long, AppUser, int> { }
```

--------------------------------

### Define Full Auditable Entity with Guid Key

Source: https://github.com/suleymanozev/crudkit/blob/main/docs/API-REFERENCE.md

Example of defining an entity that tracks creation, update, and deletion times using the default Guid key.

```csharp
public class Order : FullAuditableEntity { }
```

--------------------------------

### Tenant Resolution Configuration Example

Source: https://github.com/suleymanozev/crudkit/blob/main/CLAUDE.md

Shows how to configure multi-tenancy options, including resolving the tenant ID from a header, rejecting requests with unresolved tenants, and defining cross-tenant policies.

```csharp
opts.UseMultiTenancy()
    .ResolveTenantFromHeader("X-Tenant-Id")
    .RejectUnresolvedTenant()
    .CrossTenantPolicy(policy => { ... });
```

--------------------------------

### Define Full Auditable Entity with User Tracking

Source: https://github.com/suleymanozev/crudkit/blob/main/docs/API-REFERENCE.md

Example of defining an entity that tracks creation, update, and deletion times, along with user information, using the default Guid key.

```csharp
public class Invoice : FullAuditableEntityWithUser<AppUser> { }
```

--------------------------------

### API Request Example

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/features/value-objects.md

Demonstrates a POST request to create a product, showing how flattened `Price` properties and nested `Tax` properties are represented in the JSON payload.

```http
POST /api/products
Content-Type: application/json

{
  "name": "Widget",
  "priceAmount": 29.90,
  "priceCurrency": "USD",
  "tax": { "amount": 5.0, "currency": "TRY" }
}
```

--------------------------------

### API Tests: Test Web Application Setup

Source: https://github.com/suleymanozev/crudkit/blob/main/CLAUDE.md

Shows the pattern for creating an in-process web application for API testing, allowing configuration of endpoints and services.

```csharp
// API tests: TestWebApp.CreateAsync(configureEndpoints, configureServices) → in-process web app with test server
```

--------------------------------

### Full CrudKit Configuration Example

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/getting-started/configuration.md

Configure CrudKit with various options like pagination, routing, audit trails, import/export, multi-tenancy, and domain events. Ensure the EF provider is registered separately.

```csharp
builder.Services.AddCrudKitEf<AppDbContext>();
builder.Services.AddCrudKit(opts =>
{
    // Pagination
    opts.DefaultPageSize = 25;           // Default: 20
    opts.MinPageSize = 1;               // Default: 1
    opts.MaxPageSize = 100;              // Default: 100

    // Routing
    opts.ApiPrefix = "/api";             // Default: "/api"

    // Bulk operations
    opts.BulkLimit = 1_000;              // Default: 1,000

    // Idempotency
    opts.EnableIdempotency = true;       // Default: false

    // Audit trail — opt entities in with [Audited]
    opts.UseAuditTrail();
    // or with custom writer:
    opts.UseAuditTrail<ElasticAuditWriter>()
        .EnableAuditFailedOperations();

    // Import / Export
    opts.UseExport();                    // All entities exportable (opt-out with [NotExportable])
    opts.UseImport();                    // All entities importable (opt-out with [NotImportable])

    // Enum storage
    opts.UseEnumAsString();              // Store enums as strings in DB

    // Multi-tenancy
    opts.UseMultiTenancy()
        .ResolveTenantFromHeader("X-Tenant-Id")
        .RejectUnresolvedTenant()
        .CrossTenantPolicy(p => p.Allow("superadmin"));

    // Domain events
    opts.UseDomainEvents();
    // or with assembly scanning:
    opts.UseDomainEvents(cfg => cfg.ScanHandlersFromAssembly(typeof(Program).Assembly));
    // or with custom dispatcher:
    opts.UseDomainEvents<MyCustomDispatcher>();

    // Global hooks
    opts.UseGlobalHook<SearchIndexHook>();

    // Module discovery
    opts.ScanModulesFromAssembly = typeof(Program).Assembly;
});
```

--------------------------------

### Partial Update Example

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/features/value-objects.md

Shows how to perform a partial update on a product, sending only the fields to be changed. Other fields, like `priceCurrency`, are preserved.

```json
{ "priceAmount": 49.90 }
```

--------------------------------

### Configure Cross-Tenant Protection Policies

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/features/multi-tenant.md

Set up policies to control cross-tenant access. This example demonstrates rejecting requests when the tenant is not resolved and defining roles with specific access levels.

```csharp
opts.UseMultiTenancy()
    .ResolveTenantFromHeader("X-Tenant-Id")
    .RejectUnresolvedTenant()                    // missing header → 400
    .CrossTenantPolicy(policy =>
    {
        policy.Allow("superadmin");              // full access to all tenants
        policy.AllowReadOnly("support");          // read-only across tenants
        policy.AllowReadOnly("auditor")
              .Only<Order, Invoice>();             // read-only, restricted to these types
    });
```

--------------------------------

### Idempotency Response Examples

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/features/idempotency.md

Shows the initial creation response and the subsequent cached response when retrying with the same key.

```json
// 201 Created
{ "id": "abc-123", "customerName": "Alice", "total": 99.99 }
```

```json
// 200 OK (from cache)
{ "id": "abc-123", "customerName": "Alice", "total": 99.99 }
```

--------------------------------

### GET /api/products

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/reference/endpoints-table.md

List products with support for pagination, filtering, and sorting.

```APIDOC
## GET /api/products

### Description
Retrieves a paginated list of products, supporting filtering, sorting, and full-text search.

### Method
GET

### Endpoint
/api/products

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number (1-based)
- **per_page** (integer) - Optional - Items per page
- **sort** (string) - Optional - Sort field, prefix '-' for descending
- **search** (string) - Optional - Full-text search across searchable fields
- **include** (string) - Optional - Navigation properties to include
- **{field}** (string) - Optional - Filter by field using {op}:{value} (e.g., price=gte:100)

### Response
#### Success Response (200)
- **total** (integer) - Total count of records
- **page** (integer) - Current page number
- **per_page** (integer) - Items per page
- **data** (array) - List of product objects
```

--------------------------------

### Request Missing Tenant Header (Bash)

Source: https://context7.com/suleymanozev/crudkit/llms.txt

Example of a request that will fail with a 400 error due to a missing tenant header.

```bash
# Missing tenant header returns 400
curl "http://localhost:5000/api/orders"
```

--------------------------------

### Property-Level Attributes Example

Source: https://github.com/suleymanozev/crudkit/blob/main/docs/API-REFERENCE.md

Demonstrates various property-level attributes for security, auditing, and API behavior control.

```csharp
[CrudEntity(Resource = "users")]
[Audited]
public class User : FullAuditableEntity
{
    [Required, MaxLength(50), Searchable, Unique]
    public string Username { get; set; } = string.Empty;

    [Required, Hashed, SkipResponse]
    public string PasswordHash { get; set; } = string.Empty;

    [SkipUpdate]
    public string RegistrationSource { get; set; } = "web";

    [Protected]
    public string Role { get; set; } = "user";

    [AuditIgnore]
    public string SecurityStamp { get; set; } = string.Empty;

    [NotExportable]
    public string InternalToken { get; set; } = string.Empty;
}
```

--------------------------------

### Configure CrudKit API Options

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/reference/configuration-options.md

Demonstrates the full configuration setup for CrudKit, including EF provider registration, pagination limits, audit trails, multi-tenancy, and global hooks.

```csharp
builder.Services.AddCrudKitEf<AppDbContext>();
builder.Services.AddCrudKit(opts =>
{
    opts.DefaultPageSize = 25;
    opts.MaxPageSize = 100;
    opts.ApiPrefix = "/api";
    opts.BulkLimit = 1_000;
    opts.EnableIdempotency = true;

    opts.UseAuditTrail()
        .EnableAuditFailedOperations();

    opts.UseExport();
    opts.MaxExportRows = 50_000;
    opts.UseImport();
    opts.MaxImportFileSize = 10 * 1024 * 1024;
    opts.UseEnumAsString();
    opts.UseDomainEvents();

    opts.UseMultiTenancy()
        .ResolveTenantFromHeader("X-Tenant-Id")
        .RejectUnresolvedTenant()
        .CrossTenantPolicy(p =>
        {
            p.Allow("superadmin");
            p.AllowReadOnly("support");
        });

    opts.UseGlobalHook<SearchIndexHook>();
    opts.UseGlobalHook<CacheInvalidationHook>();

    opts.ScanModulesFromAssembly = typeof(Program).Assembly;
});
```

--------------------------------

### API Response Example

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/features/value-objects.md

Illustrates a typical API response for a product, showcasing the flattened `priceAmount` and `priceCurrency`, and the nested `tax` object.

```json
{
  "id": "abc-123",
  "name": "Widget",
  "priceAmount": 29.90,
  "priceCurrency": "USD",
  "tax": { "amount": 5.0, "currency": "TRY" }
}
```

--------------------------------

### Configure CrudEntity with Custom Resource and Bulk Operations

Source: https://github.com/suleymanozev/crudkit/blob/main/docs/API-REFERENCE.md

Example of configuring an entity with a custom resource name and enabling bulk delete operations with a specific limit.

```csharp
[CrudEntity(
    Resource = "orders",
    EnableBulkDelete = true,
    BulkLimit = 500)]
public class Order : FullAuditableEntity { }
```

--------------------------------

### CSV Format Examples

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/features/import-export.md

Standard CSV structure used for both export output and import file uploads.

```csv
Name,Price
Widget,29.90
Gadget,49.90
```

```csv
Name,Price
New Product,19.90
Another Product,39.90
```

--------------------------------

### Full Invoice Approval Event Flow Example

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/features/domain-events.md

Demonstrates a complete domain event flow including event definition, entity raising the event, transition hook, and multiple handlers reacting to the event.

```csharp
// 1. Define the event
public record InvoiceApprovedEvent(Guid InvoiceId, decimal Total) : IDomainEvent;

// 2. Entity raises event
[CrudEntity]
public class Invoice : FullAuditableAggregateRoot, IStateMachine<InvoiceStatus>
{
    public string InvoiceNumber { get; set; } = "";
    public decimal Total { get; set; }

    [Protected]
    public InvoiceStatus Status { get; set; } = InvoiceStatus.Draft;

    public static IReadOnlyList<(InvoiceStatus, InvoiceStatus, string)> Transitions =>
    [
        (InvoiceStatus.Draft, InvoiceStatus.Approved, "approve"),
    ];
}

// 3. Hook raises the event during transition
public class InvoiceTransitionHook : ITransitionHook<Invoice>
{
    public Task BeforeTransition(Invoice entity, string action, object? payload, AppContext ctx)
    {
        if (action == "approve")
            entity.AddDomainEvent(new InvoiceApprovedEvent(entity.Id, entity.Total));
        return Task.CompletedTask;
    }
}

// 4. Handler reacts
public class SendInvoiceEmailHandler : IDomainEventHandler<InvoiceApprovedEvent>
{
    private readonly IEmailService _email;

    public SendInvoiceEmailHandler(IEmailService email) => _email = email;

    public async Task HandleAsync(InvoiceApprovedEvent e, CancellationToken ct = default)
    {
        await _email.SendAsync($"Invoice {e.InvoiceId} approved for {e.Total:C}");
    }
}

// 5. Multiple handlers for the same event
public class CreateAccountingEntryHandler : IDomainEventHandler<InvoiceApprovedEvent>
{
    public async Task HandleAsync(InvoiceApprovedEvent e, CancellationToken ct = default)
    {
        // Create accounting journal entry...
    }
}
```

--------------------------------

### Configure Multi-Tenancy

Source: https://context7.com/suleymanozev/crudkit/llms.txt

Configure multi-tenancy by defining how tenants are resolved and setting cross-tenant access policies. This example resolves tenants from a header and restricts access for certain roles.

```csharp
// Entity with multi-tenancy
public class Order : FullAuditableEntity, IMultiTenant
{
    public string TenantId { get; set; } = string.Empty;
    public string CustomerName { get; set; } = string.Empty;
}

// Configuration with tenant resolution and cross-tenant policies
builder.Services.AddCrudKit<AppDbContext>(opts =>
{
    opts.UseMultiTenancy()
        .ResolveTenantFromHeader("X-Tenant-Id")       // or ResolveTenantFromClaim("tenant_id")
        .RejectUnresolvedTenant()                      // missing tenant → 400
        .CrossTenantPolicy(policy =>
        {
            policy.Allow("superadmin");                // full access to all tenants
            policy.AllowReadOnly("support");           // read-only across tenants
            policy.AllowReadOnly("auditor")
                  .Only<Order, Invoice>();             // read-only, restricted to specific types
        });
});
```

--------------------------------

### Build and Test Commands for CrudKit

Source: https://github.com/suleymanozev/crudkit/blob/main/CLAUDE.md

Provides essential .NET CLI commands for building the solution, running all tests, targeting specific projects or tests, and starting the Docusaurus documentation development server.

```bash
# Build entire solution
dotnet build CrudKit.slnx
```

```bash
# Run all tests (565 tests across 5 projects)
dotnet test CrudKit.slnx
```

```bash
# Run tests for a specific project
dotnet test tests/CrudKit.Api.Tests/
dotnet test tests/CrudKit.EntityFrameworkCore.Tests/
dotnet test tests/CrudKit.Core.Tests/
dotnet test tests/CrudKit.Identity.Tests/
```

```bash
# Run a single test
dotnet test tests/CrudKit.Api.Tests/ --filter "ClassName.MethodName"
```

```bash
# Run tests matching a pattern
dotnet test tests/CrudKit.Api.Tests/ --filter "FullyQualifiedName~PurgeEndpoint"
```

```bash
# Documentation site (Docusaurus)
cd docs-site && npm start        # dev server
cd docs-site && npx docusaurus build  # verify build
```

--------------------------------

### Fake CurrentUser for Testing (Anonymous)

Source: https://github.com/suleymanozev/crudkit/blob/main/docs/API-REFERENCE.md

Shows the setup for an anonymous user, which is the default fallback when no other ICurrentUser implementation is found.

```csharp
// Unauthenticated user (default fallback registered by AddCrudKit)
var anon = new AnonymousCurrentUser();
// IsAuthenticated = false, no roles, no permissions
```

--------------------------------

### Bulk Update Protection Example

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/guides/security.md

Attempting to update protected fields like `TenantId` during a bulk update will result in a 400 Bad Request error.

```json
POST /api/products/bulk-update
{
  "ids": ["..."],
  "patch": { "tenantId": "attacker-tenant" }
}
// → 400: "Cannot update protected field: TenantId"
```

--------------------------------

### Implement Custom Audit Writer

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/features/audit-trail.md

Implement the `IAuditWriter` interface to define how audit entries are persisted. This example shows writing to Elasticsearch.

```csharp
opts.UseAuditTrail<ElasticAuditWriter>();

public class ElasticAuditWriter : IAuditWriter
{
    public async Task WriteAsync(IReadOnlyList<AuditEntry> entries, CancellationToken ct)
    {
        // Write to Elasticsearch, separate DB, file, etc.
    }
}
```

--------------------------------

### CrudKit Feature Flag Configuration Example

Source: https://github.com/suleymanozev/crudkit/blob/main/CLAUDE.md

Demonstrates the 3-level hierarchy for configuring feature flags (e.g., Export, Audited, Importable) using property attributes, entity attributes, and global flags.

```csharp
// Example (Export):
//   Global: opts.UseExport()           → all entities exportable
//   Entity: [NotExportable]            → this entity opts out
//   Property: [NotExportable]          → this field excluded from export

// Same pattern: Audited/NotAudited, Exportable/NotExportable, Importable/NotImportable,
//               Filterable/NotFilterable, Sortable/NotSortable
```

--------------------------------

### Quick Setup: Derive AppDbContext from CrudKitIdentityDbContext

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/guides/identity.md

Derive your custom DbContext from `CrudKitIdentityDbContext<TUser>` instead of `CrudKitDbContext` to include ASP.NET Identity features alongside CrudKit's.

```csharp
public class AppUser : IdentityUser { }

public class AppDbContext : CrudKitIdentityDbContext<AppUser>
{
    public AppDbContext(
        DbContextOptions<AppDbContext> options,
        ICurrentUser currentUser)
        : base(options, currentUser) { }

    public DbSet<Product> Products => Set<Product>();
    public DbSet<Order> Orders => Set<Order>();
}
```

--------------------------------

### Define Auditable Entity with Guid Key

Source: https://github.com/suleymanozev/crudkit/blob/main/docs/API-REFERENCE.md

Example of defining an entity that tracks creation and update times using the default Guid key.

```csharp
public class Product : AuditableEntity { }
```

--------------------------------

### Define Full Auditable Entity with Custom Key and User Types

Source: https://github.com/suleymanozev/crudkit/blob/main/docs/API-REFERENCE.md

Example of defining an entity with custom key types for the entity, user ID, and user key.

```csharp
public class LegacyOrder : FullAuditableEntityWithUser<long, AppUser, int> { }
```

--------------------------------

### Import Workflow via CLI and C#

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/features/import-export.md

Demonstrates exporting a template and importing data using curl or C# HttpClient.

```bash
# 1. Export existing data as template
curl -o template.csv "https://api.example.com/api/products/export?format=csv"

# 2. Edit the CSV (add new rows, modify values)

# 3. Import
curl -X POST "https://api.example.com/api/products/import" \
  -F "file=@products.csv"
```

```csharp
// C# HttpClient
using var form = new MultipartFormDataContent();
form.Add(new StreamContent(File.OpenRead("products.csv")), "file", "products.csv");

var response = await httpClient.PostAsync("/api/products/import", form);
var result = await response.Content.ReadFromJsonAsync<ImportResult>();
Console.WriteLine($"Created: {result.Created}, Failed: {result.Failed}");
```

--------------------------------

### Minimal Program Configuration

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/advanced/modular-monolith.md

Initialize CrudKit in Program.cs to automatically discover and register modules.

```csharp
builder.Services.AddCrudKitEf<SharedDbContext>();
builder.Services.AddCrudKit(opts =>
{
    opts.ScanModulesFromAssembly = typeof(Program).Assembly;
});

var app = builder.Build();
app.UseCrudKit();  // discovers modules, calls RegisterServices + MapEndpoints
app.Run();
```

--------------------------------

### POST /api/products/{id}/transition/{action}

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/reference/endpoints-table.md

Perform a state transition on a product entity.

```APIDOC
## POST /api/products/{id}/transition/{action}

### Description
Executes a state transition for an entity that implements IStateMachine.

### Method
POST

### Endpoint
/api/products/{id}/transition/{action}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the product
- **action** (string) - Required - The state transition action to perform
```

--------------------------------

### Conflict Response for Optimistic Concurrency

Source: https://context7.com/suleymanozev/crudkit/llms.txt

Example of the JSON response received when an optimistic concurrency conflict occurs.

```json
{
  "status": 409,
  "code": "CONFLICT",
  "message": "The record has been modified by another user. Please refresh and try again."
}
```

--------------------------------

### Error Response for Missing Tenant

Source: https://context7.com/suleymanozev/crudkit/llms.txt

Example of the JSON error response when a required tenant ID is missing.

```json
{
  "status": 400,
  "code": "TENANT_REQUIRED",
  "message": "A tenant ID is required for this request."
}
```

--------------------------------

### Build Static Website Content

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/README.md

Generates static website files into the 'build' directory, ready for hosting.

```bash
yarn build
```

--------------------------------

### Apply Entity Framework Migrations

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/getting-started/quick-start.md

Run migrations to update the database schema.

```bash
dotnet ef migrations add InitialCreate -c AppDbContext
dotnet ef database update -c AppDbContext
```

--------------------------------

### Define Basic Entity

Source: https://context7.com/suleymanozev/crudkit/llms.txt

Define a basic entity with a Guid Id using the Entity base class.

```csharp
// Basic entity with Guid Id only
public class Currency : Entity { }
```

--------------------------------

### GET /api/{resource}/export

Source: https://github.com/suleymanozev/crudkit/blob/main/docs/API-REFERENCE.md

Export resources to CSV format with support for existing filters and sorting.

```APIDOC
## GET /api/{resource}/export

### Description
Exports matching records to a CSV file based on applied filters and sorting.

### Method
GET

### Endpoint
/api/{resource}/export

### Parameters
#### Query Parameters
- **format** (string) - Required - Must be 'csv'.
- **{filters}** (string) - Optional - Same filtering parameters as the list endpoint.
```

--------------------------------

### Deploy Website using SSH

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/README.md

Deploys the website using SSH. Ensure SSH keys are configured for your Git provider.

```bash
USE_SSH=true yarn deploy
```

--------------------------------

### GET /api/{resource}

Source: https://github.com/suleymanozev/crudkit/blob/main/docs/API-REFERENCE.md

Retrieve a list of entities with support for filtering, sorting, pagination, and eager loading.

```APIDOC
## GET /api/{resource}

### Description
Retrieves a paginated list of resources with optional filtering, sorting, and navigation property loading.

### Method
GET

### Endpoint
/api/{resource}

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve.
- **per_page** (integer) - Optional - Number of items per page.
- **sort** (string) - Optional - Field to sort by. Prefix with '-' for descending order.
- **include** (string) - Optional - Navigation properties to eager load.
- **{field}** (string) - Optional - Filter by field using operators (eq, neq, gt, gte, lt, lte, like, starts, in, null, notnull).

### Response
#### Success Response (200)
- **total** (integer) - Total count of records.
- **page** (integer) - Current page number.
- **per_page** (integer) - Items per page.
- **data** (array) - List of entities.
```

--------------------------------

### Testing TimeProvider Configuration

Source: https://github.com/suleymanozev/crudkit/blob/main/docs/API-REFERENCE.md

Demonstrates how to inject a fake TimeProvider for testing purposes and advance time.

```csharp
// Testing — inject a fake time provider
var fakeTime = new FakeTimeProvider(new DateTimeOffset(2026, 1, 1, 0, 0, 0, TimeSpan.Zero));
var db = new AppDbContext(options, currentUser, fakeTime);

// Advance time between operations
fakeTime.Advance(TimeSpan.FromHours(5));
```

--------------------------------

### Bulk Update Response Example

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/features/bulk-operations.md

The response to a bulk update request indicates the number of records successfully updated.

```json
{ "updated": 2 }
```

--------------------------------

### Bulk Delete Response Example

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/features/bulk-operations.md

The response to a bulk delete request indicates the number of records successfully deleted.

```json
{ "deleted": 3 }
```

--------------------------------

### Perform Initial Migration

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/guides/migrations.md

Commands to generate and apply the initial migration including CrudKit internal tables and application entities.

```bash
# Initial migration includes CrudKit internal tables + your entities
dotnet ef migrations add InitialCreate -c AppDbContext

# Apply to database
dotnet ef database update -c AppDbContext
```

--------------------------------

### Define Base Entity Interfaces

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/reference/interfaces.md

Base interfaces for all entities, where IEntity requires a key and IEntity defaults to a Guid.

```csharp
public interface IEntity<TKey> where TKey : notnull
{
    TKey Id { get; set; }
}

public interface IEntity : IEntity<Guid> { }
```

--------------------------------

### Get by ID Endpoint

Source: https://context7.com/suleymanozev/crudkit/llms.txt

Retrieve a single entity by its ID. This endpoint supports optional navigation property includes.

```APIDOC
## Get by ID Endpoint

Retrieve a single entity by its ID with optional navigation property includes.

```bash
# Get single product
curl "http://localhost:5000/api/products/550e8400-e29b-41d4-a716-446655440000"

# Get order with related lines
curl "http://localhost:5000/api/orders/550e8400-e29b-41d4-a716-446655440000?include=lines"
```

Response:
```json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Smartphone Pro",
  "price": 999.99,
  "sku": "PHONE-001",
  "description": "Latest smartphone model",
  "createdAt": "2026-01-15T10:30:00Z",
  "updatedAt": "2026-01-15T10:30:00Z"
}
```

Error response (404):
```json
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Product with ID '550e8400-e29b-41d4-a716-446655440000' was not found."
}
```
```

--------------------------------

### Configure CrudEntity Endpoint Flags

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/advanced/feature-flags.md

Examples of using CrudEntity attributes to control generated API endpoints for specific entities.

```csharp
// Read-only entity — List + Get only, no POST/PUT/DELETE
[CrudEntity(ReadOnly = true)]
public class Currency : Entity
{
    public string Code { get; set; } = "";  // "USD", "EUR"
    public string Name { get; set; } = "";
    public string Symbol { get; set; } = "";
}
// Generated: GET /api/currencies, GET /api/currencies/{id}
// NOT generated: POST, PUT, DELETE

// No delete allowed
[CrudEntity(EnableDelete = false, EnableUpdate = false)]
public class AuditEntry : AuditableEntity { }
// Generated: GET (list), GET (by id), POST
// NOT generated: PUT, DELETE

// Selective write operations
[CrudEntity(EnableCreate = true, EnableUpdate = true, EnableDelete = false)]
public class Order : FullAuditableEntity { }
// Can create and update but never delete

// Bulk operations enabled with limit
[CrudEntity(EnableBulkDelete = true, EnableBulkUpdate = true, BulkLimit = 500)]
public class Product : AuditableEntity { }
```

--------------------------------

### Register Modules

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/advanced/modular-monolith.md

Configure module discovery via assembly scanning or manual registration.

```csharp
// Automatically discovers all IModule implementations
opts.ScanModulesFromAssembly = typeof(Program).Assembly;
```

```csharp
builder.Services.AddCrudKitModule<OrderModule>();
```

--------------------------------

### Configure AppDbContext with CrudKitDbContextDependencies

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/getting-started/configuration.md

Inject CrudKitDbContextDependencies into your DbContext constructor for cleaner dependency management, especially in modular monolith setups.

```csharp
public class AppDbContext : CrudKitDbContext
{
    public AppDbContext(
        DbContextOptions<AppDbContext> options,
        CrudKitDbContextDependencies dependencies)
        : base(options, dependencies) { }
}
```

--------------------------------

### Execute state machine transitions

Source: https://context7.com/suleymanozev/crudkit/llms.txt

Endpoints for transitioning entities implementing IStateMachine. Invalid transitions return a 400 error.

```bash
# Transition order from Pending to Processing
curl -X POST "http://localhost:5000/api/orders/550e8400-e29b-41d4-a716-446655440000/transition/process"

# Transition from Processing to Completed
curl -X POST "http://localhost:5000/api/orders/550e8400-e29b-41d4-a716-446655440000/transition/complete"

# Invalid transition returns 400
curl -X POST "http://localhost:5000/api/orders/550e8400-e29b-41d4-a716-446655440000/transition/complete"
```

```json
{
  "status": 400,
  "code": "BAD_REQUEST",
  "message": "Invalid transition 'complete' from state 'Completed'."
}
```

--------------------------------

### Create Initial EF Core Migration

Source: https://github.com/suleymanozev/crudkit/blob/main/docs/API-REFERENCE.md

Generate the initial database migration, including CrudKit's internal tables and your application's entities, using the EF Core CLI.

```bash
# Initial migration includes CrudKit internal tables + your entities
dotnet ef migrations add InitialCreate -c AppDbContext
```

--------------------------------

### GET /api/products/export

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/features/import-export.md

Exports matching records as a CSV file. Supports filtering and sorting parameters consistent with the List endpoint.

```APIDOC
## GET /api/products/export

### Description
Exports matching records as a CSV file. Supports the same filters and sort parameters as the List endpoint.

### Method
GET

### Endpoint
/api/products/export

### Parameters
#### Query Parameters
- **format** (string) - Required - The format of the export, must be 'csv'.
- **[filter_params]** (string) - Optional - Filters applied to the export (e.g., price=gte:100).
- **sort** (string) - Optional - Sorting criteria (e.g., -name).

### Response
#### Success Response (200)
- **CSV Content** (text/csv) - The exported data in CSV format.
```

--------------------------------

### POST /api/orders/{id}/transition/{action}

Source: https://context7.com/suleymanozev/crudkit/llms.txt

Handles state machine transitions for order entities.

```APIDOC
## POST /api/orders/{id}/transition/{action}

### Description
Triggers a state transition for an order based on the defined state machine.

### Method
POST

### Endpoint
/api/orders/{id}/transition/{action}

### Parameters
#### Path Parameters
- **id** (string) - Required - The order ID.
- **action** (string) - Required - The transition action (e.g., 'process', 'complete').

### Response
#### Error Response (400)
- **status** (integer) - HTTP status code
- **code** (string) - Error code
- **message** (string) - Error description
```

--------------------------------

### Get Entity with RowVersion

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/features/concurrency.md

Retrieve an entity using its ID. Note the inclusion of the 'rowVersion' in the response, which is crucial for subsequent updates.

```http
GET /api/products/abc-123
```

--------------------------------

### Implement Per-Entity Hooks for a Product Entity

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/features/hooks.md

Implement ICrudHooks<Product> to intercept operations for the Product entity. Override BeforeCreate to normalize SKU data. Default implementations for all hook methods are empty.

```csharp
public class ProductHooks : ICrudHooks<Product>
{
    public Task BeforeCreate(Product entity, AppContext ctx)
    {
        entity.Sku = entity.Sku.ToUpperInvariant();
        return Task.CompletedTask;
    }

    public Task AfterCreate(Product entity, AppContext ctx)
    {
        // send event, invalidate cache, etc.
        return Task.CompletedTask;
    }
}

builder.Services.AddScoped<ICrudHooks<Product>, ProductHooks>();
```

--------------------------------

### Configure CrudKit Services

Source: https://github.com/suleymanozev/crudkit/blob/main/README.md

Configure CrudKit services in your application's startup. This includes setting default page sizes, API prefixes, bulk limits, enabling idempotency, audit trails, import/export, enum storage, multi-tenancy, and global hooks.

```csharp
builder.Services.AddCrudKitEf<AppDbContext>();
builder.Services.AddCrudKit(opts =>
{
    // Pagination
    opts.DefaultPageSize = 25;           // Default: 20
    opts.MaxPageSize = 100;              // Default: 100

    // Routing
    opts.ApiPrefix = "/api";             // Default: "/api"

    // Bulk operations
    opts.BulkLimit = 1_000;              // Default: 1,000

    // Idempotency
    opts.EnableIdempotency = true;       // Default: false

    // Audit trail — opt entities in with [Audited]
    opts.UseAuditTrail();
    // or with custom writer:
    opts.UseAuditTrail<ElasticAuditWriter>()
        .EnableAuditFailedOperations();

    // Import / Export
    opts.UseExport();                    // All entities exportable (opt-out with [NotExportable])
    opts.MaxExportRows = 50_000;         // Default: 50,000
    opts.UseImport();                    // All entities importable (opt-out with [NotImportable])
    opts.MaxImportFileSize = 10 * 1024 * 1024; // Default: 10 MB

    // Enum storage
    opts.UseEnumAsString();              // Store enums as strings in DB

    // Multi-tenancy
    opts.UseMultiTenancy()
        .ResolveTenantFromHeader("X-Tenant-Id")
        .RejectUnresolvedTenant()
        .CrossTenantPolicy(p => p.Allow("superadmin"));

    // Global hooks
    opts.UseGlobalHook<SearchIndexHook>();

    // Module discovery
    opts.ScanModulesFromAssembly = typeof(Program).Assembly;
});
```

--------------------------------

### Endpoint Mapping Overloads

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/advanced/custom-endpoints.md

Provides examples of different overloads for `MapCrudEndpoints` to configure CRUD operations with or without explicit route prefixes.

```APIDOC
## Endpoint Mapping Overloads

### Description
Demonstrates various ways to map CRUD endpoints using `MapCrudEndpoints`.

### Method | Endpoint
---|---
`app.MapCrudEndpoints<TEntity, TCreate, TUpdate>()` | Route derived from entity name (e.g., `/api/entities`)
`app.MapCrudEndpoints<TEntity>()` | ReadOnly CRUD (List + Get only), route derived from entity name.
`app.MapCrudEndpoints<TEntity, TCreate, TUpdate>("products")` | Full CRUD with an explicit route prefix.
`app.MapCrudEndpoints<TEntity>("units")` | ReadOnly CRUD with an explicit route prefix.

### Parameters
- **TEntity**: The entity type.
- **TCreate**: The DTO type for creating entities.
- **TUpdate**: The DTO type for updating entities.
- **Route Prefix**: (Optional) A string specifying the explicit route prefix for the endpoints.
```

--------------------------------

### Implement State Machine Transitions

Source: https://github.com/suleymanozev/crudkit/blob/main/docs/API-REFERENCE.md

Define state transitions by implementing IStateMachine and providing a list of valid state changes.

```csharp
public enum OrderStatus { Pending, Processing, Completed, Cancelled }

[CrudEntity(Resource = "orders")]
public class Order : FullAuditableEntity, IStateMachine<OrderStatus>
{
    public string CustomerName { get; set; } = string.Empty;
    public decimal Total { get; set; }

    [Protected]
    public OrderStatus Status { get; set; } = OrderStatus.Pending;

    public static IReadOnlyList<(OrderStatus From, OrderStatus To, string Action)> Transitions =>
    [
        (OrderStatus.Pending,    OrderStatus.Processing, "process"),
        (OrderStatus.Processing, OrderStatus.Completed,  "complete"),
        (OrderStatus.Pending,    OrderStatus.Cancelled,  "cancel"),
        (OrderStatus.Processing, OrderStatus.Cancelled,  "cancel"),
    ];
}
```

--------------------------------

### EF Tests: In-Memory SQLite Database Creation

Source: https://github.com/suleymanozev/crudkit/blob/main/CLAUDE.md

Illustrates the pattern for setting up an in-memory SQLite database for Entity Framework tests using a helper method that returns a test DbContext.

```csharp
// EF tests: DbHelper.CreateDb() → in-memory SQLite, returns TestDbContext
```

--------------------------------

### ICurrentUser Interface and JWT Implementation

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/features/auth.md

Details the ICurrentUser interface for integrating custom authentication systems and provides a concrete JWT implementation example.

```APIDOC
## ICurrentUser Interface and JWT Implementation

### Description
Implement the `ICurrentUser` interface to integrate your application's authentication system with CrudKit. A JWT implementation example is provided, showing how to extract user information from claims.

### Method
N/A (Interface and Implementation)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```csharp
// ICurrentUser Interface Definition
public interface ICurrentUser
{
    string? Id { get; }
    string? Username { get; }
    IReadOnlyList<string> Roles { get; }
    IReadOnlyList<Permission> Permissions { get; }
    bool IsAuthenticated { get; }
    bool HasRole(string role);
    bool HasPermission(string entity, string action);
    IReadOnlyList<string>? AccessibleTenants { get; }
}

// JWT Implementation Example
public class JwtCurrentUser : ICurrentUser
{
    private readonly IHttpContextAccessor _http;

    public JwtCurrentUser(IHttpContextAccessor http) => _http = http;

    private ClaimsPrincipal? User => _http.HttpContext?.User;

    public string? Id => User?.FindFirst(ClaimTypes.NameIdentifier)?.Value;
    public string? Username => User?.FindFirst(ClaimTypes.Name)?.Value;
    public bool IsAuthenticated => User?.Identity?.IsAuthenticated ?? false;

    public IReadOnlyList<string> Roles =>
        User?.FindAll(ClaimTypes.Role).Select(c => c.Value).ToList()
        ?? [];

    public IReadOnlyList<Permission> Permissions =>
        User?.FindAll("permission").Select(c =>
        {
            var parts = c.Value.Split(':');
            return new Permission(parts[0], parts[1]);
        }).ToList() ?? [];

    public bool HasRole(string role) => Roles.Contains(role);

    public bool HasPermission(string entity, string action)
        => Permissions.Any(p => p.Entity == entity && p.Action == action);

    public IReadOnlyList<string>? AccessibleTenants =>
        User?.FindAll("tenant").Select(c => c.Value).ToList();
}

// Registration in Program.cs
// builder.Services.AddHttpContextAccessor();
// builder.Services.AddScoped<ICurrentUser, JwtCurrentUser>();
```

### Response
#### Success Response (200)
N/A (This section describes interface and implementation)

#### Response Example
N/A
```

--------------------------------

### Bulk Delete Request Example

Source: https://github.com/suleymanozev/crudkit/blob/main/docs-site/docs/features/bulk-operations.md

Send a POST request to the bulk delete endpoint with a JSON body containing an array of IDs to delete.

```http
POST /api/products/bulk-delete
Content-Type: application/json

{ "ids": ["id-1", "id-2", "id-3"] }
```
Tokens:
Raw