technical-design-patterns

Technical Design Patterns

Create comprehensive technical design documents that guide implementation of ABP Framework features.

When to Use

• Designing REST API endpoints and contracts
• Planning database schemas and indexes
• Creating Technical Specification Documents (TSD)
• Documenting Architecture Decision Records (ADRs)
• Defining DTO structures and validation rules

Technical Design Document Structure

A complete TSD for an ABP feature includes:

1. Overview - Feature summary and scope
2. API Contract - Endpoints, methods, DTOs
3. Database Schema - Tables, columns, indexes, relationships
4. Permissions - Required permissions and role mappings
5. Validation Rules - Input constraints
6. Caching Strategy - What to cache, TTL
7. Open Questions - Items needing clarification

API Contract Template

## API: {Resource}

### Overview
| Attribute | Value |
|-----------|-------|
| Base Path | `/api/app/{resources}` |
| Authentication | Required |
| Rate Limit | 100/min |

### Endpoints

| Method | Path | Description | Permission | Request | Response |
|--------|------|-------------|------------|---------|----------|
| GET | `/{resources}` | List with pagination | `{Project}.{Resources}` | `Get{Resource}ListInput` | `PagedResultDto<{Resource}Dto>` |
| GET | `/{resources}/{id}` | Get by ID | `{Project}.{Resources}` | - | `{Resource}Dto` |
| POST | `/{resources}` | Create new | `{Project}.{Resources}.Create` | `CreateUpdate{Resource}Dto` | `{Resource}Dto` |
| PUT | `/{resources}/{id}` | Update existing | `{Project}.{Resources}.Edit` | `CreateUpdate{Resource}Dto` | `{Resource}Dto` |
| DELETE | `/{resources}/{id}` | Soft delete | `{Project}.{Resources}.Delete` | - | - |

### DTOs

#### {Resource}Dto (Output)
```json
{
  "id": "guid",
  "property1": "string",
  "property2": 0,
  "creationTime": "datetime",
  "lastModificationTime": "datetime"
}

CreateUpdate{Resource}Dto (Input)

{
  "property1": "string (required, max 100)",
  "property2": "number (optional, min 0)"
}

Get{Resource}ListInput (Query)

{
  "filter": "string (optional)",
  "sorting": "string (optional, e.g., 'name asc')",
  "skipCount": "number (default 0)",
  "maxResultCount": "number (default 10, max 100)"
}