4e8e5069fa
- Added: api-patterns, app-builder, architecture, bash-linux, behavioral-modes, clean-code, code-review-checklist, database-design, deployment-procedures, docker-expert, documentation-templates, game-development, geo-fundamentals, i18n-localization, lint-and-validate, mobile-design, nestjs-expert, nextjs-best-practices, nodejs-best-practices, parallel-agents, performance-profiling, plan-writing, powershell-windows, prisma-expert, python-patterns, react-patterns, red-team-tactics, seo-fundamentals, server-management, tailwind-patterns, tdd-workflow, typescript-expert, vulnerability-scanner - Updated README: skill count 179 → 223 - Added credit for vudovn/antigravity-kit (MIT License) Source: https://github.com/vudovn/antigravity-kit
38 lines
921 B
Markdown
38 lines
921 B
Markdown
# Response Format Principles
|
|
|
|
> Consistency is key - choose a format and stick to it.
|
|
|
|
## Common Patterns
|
|
|
|
```
|
|
Choose one:
|
|
├── Envelope pattern ({ success, data, error })
|
|
├── Direct data (just return the resource)
|
|
└── HAL/JSON:API (hypermedia)
|
|
```
|
|
|
|
## Error Response
|
|
|
|
```
|
|
Include:
|
|
├── Error code (for programmatic handling)
|
|
├── User message (for display)
|
|
├── Details (for debugging, field-level errors)
|
|
├── Request ID (for support)
|
|
└── NOT internal details (security!)
|
|
```
|
|
|
|
## Pagination Types
|
|
|
|
| Type | Best For | Trade-offs |
|
|
|------|----------|------------|
|
|
| **Offset** | Simple, jumpable | Performance on large datasets |
|
|
| **Cursor** | Large datasets | Can't jump to page |
|
|
| **Keyset** | Performance critical | Requires sortable key |
|
|
|
|
### Selection Questions
|
|
|
|
1. How large is the dataset?
|
|
2. Do users need to jump to specific pages?
|
|
3. Is data frequently changing?
|