Menü
Design de API REST seguindo boas práticas. Use quando pedirem para projetar API, definir endpoints, criar contrato REST ou OpenAPI.
Mit Codex oder Claude installieren Kopieren Sie diesen Prompt, fügen Sie ihn in Codex, Claude oder einen anderen Assistant ein und lassen Sie die Skill-Seite prüfen und installieren.
Basierend auf der SOC-Berufsklassifikation
Acione o `tech-writer` para criar um novo Architecture Decision Record (ADR).
Template e guia para ADRs (Architecture Decision Records): quando criar, estrutura, exemplos. Use quando documentar decisões arquiteturais ou criar ADRs.
Padrões Android modernos: Kotlin, Jetpack Compose, MVVM, Hilt, Room, Navigation, Coroutines, testes. Use quando implementar features em Android nativo.
Padrões Angular modernos: Standalone Components, Signals, inject(), HttpClient, RxJS, Testing. Use quando implementar features em Angular ou configurar projeto Angular.
Migração AngularJS para Angular: estratégia incremental, ngUpgrade, dual-boot, padrões de coexistência. Use quando planejar ou executar migração de AngularJS (1.x) para Angular moderno.
Acione o `architect-reviewer` para uma análise arquitetural focada.
| name | api-design |
| description | Design de API REST seguindo boas práticas. Use quando pedirem para projetar API, definir endpoints, criar contrato REST ou OpenAPI. |
| argument-hint | [contexto adicional] |
Projete ou revise uma API REST seguindo boas práticas consolidadas.
/orders, /users, /payments/users/{id}/ordersPOST /orders não POST /createOrder/order-items| Method | Semântica | Idempotente | Body |
|---|---|---|---|
| GET | Ler recurso(s) | Sim | Não |
| POST | Criar recurso | Não | Sim |
| PUT | Substituir recurso inteiro | Sim | Sim |
| PATCH | Atualizar parcialmente | Não* | Sim |
| DELETE | Remover recurso | Sim | Não |
| Código | Quando usar |
|---|---|
| 200 | Sucesso com body |
| 201 | Recurso criado (POST) — incluir Location header |
| 204 | Sucesso sem body (DELETE, PUT) |
| 400 | Input inválido — detalhar o que está errado |
| 401 | Não autenticado |
| 403 | Autenticado mas sem permissão |
| 404 | Recurso não encontrado |
| 409 | Conflito (duplicata, estado inválido) |
| 422 | Validação de negócio falhou |
| 429 | Rate limit excedido |
| 500 | Erro interno — nunca expor stack trace |
GET /orders?page=1&size=20&sort=createdAt,desc
{
"content": [...],
"page": { "number": 1, "size": 20, "totalElements": 150, "totalPages": 8 }
}
{
"type": "https://api.example.com/errors/insufficient-funds",
"title": "Insufficient Funds",
"status": 422,
"detail": "Account balance is 30.00 but transfer requires 50.00",
"instance": "/transfers/txn-123"
}
?status=PENDING&minAmount=100?createdAfter=2024-01-01/v2/orders) ou header (Accept-Version: 2)Quando projetando API, entregue: