SkillProgramaçãoCriação
Designer de API
Projeta APIs REST ou GraphQL, escreve especificações OpenAPI e planeja arquitetura de API — modelagem de recursos, versionamento, paginação e tratamento de erros. Use ao desenhar uma nova API ou reestruturar uma existente.
Ações
PerfilDev
ProfundidadeAlta
IdiomaInglês (skill original)
Objetivo
Em uma frase.
Projetar APIs que sejam usáveis, evolutivas e consistentes. A skill cobre modelagem de recursos, estratégia de versionamento, padrões de paginação, formatos de erro, autenticação e geração de especificação OpenAPI como fonte única da verdade.
Aplicação
Quando
faz sentido.
Usar
- Design de uma nova API.
- Reestruturação relevante de uma API existente.
- Definição de contrato entre múltiplos serviços.
Não usar
- Revisão de um design existente (use api-design-reviewer).
- Construção de servidores MCP (use mcp-builder).
- Testes de API (use api-test-suite-builder).
Prompt
Instruções
para a IA.
A skill orienta as decisões centrais de design de uma API.
### Modelagem de recursos e semântica HTTP
Use substantivos, não verbos (
### Versionamento e paginação
Prefira prefixo na URL (
### Erros, autenticação e OpenAPI
Padronize o formato de erro com código, mensagem legível e detalhes. Para autenticação, use bearer token na maioria dos casos, API key para server-to-server e fluxos OAuth com identidades de terceiros. Gere a especificação OpenAPI a partir de anotações no código ou escreva o
O resultado final é a especificação OpenAPI, o racional de design, a política de versionamento e o catálogo de erros.
### Modelagem de recursos e semântica HTTP
Use substantivos, não verbos (
/users, não /getUsers); coleções no plural e itens no singular; recursos aninhados apenas quando a posse for real, evitando mais de dois níveis de aninhamento. Respeite a semântica HTTP: GET seguro e idempotente; POST cria e retorna 201 + Location; PUT substitui por completo; PATCH atualiza parcialmente; DELETE retorna 204.### Versionamento e paginação
Prefira prefixo na URL (
/v1/, /v2/) pela simplicidade, ou versão por header quando quiser algo mais limpo. Sempre ofereça caminho de migração e anuncie deprecações publicamente com prazo. Para paginação, use cursor em alto volume com ordem estável e offset em UIs administrativas de baixo volume.### Erros, autenticação e OpenAPI
Padronize o formato de erro com código, mensagem legível e detalhes. Para autenticação, use bearer token na maioria dos casos, API key para server-to-server e fluxos OAuth com identidades de terceiros. Gere a especificação OpenAPI a partir de anotações no código ou escreva o
openapi.yaml à mão e gere os tipos, mantendo sempre uma fonte única da verdade.O resultado final é a especificação OpenAPI, o racional de design, a política de versionamento e o catálogo de erros.
Execução
Como usar
com IA.
- 01Copie a skill (botão "Copiar skill para IA", no topo): o texto copiado já é a skill completa, não um resumo.
- 02Abra o Claude ou Claude Code e cole — a IA recebe todas as instruções e fica pronta para a tarefa.
- 03Prefere usar como arquivo reutilizável? Baixe o .zip e coloque o
SKILL.mdem.claude/skills/(Claude Code) ou anexe o arquivo no Claude (claude.ai).