Princípios de Design de API
Domine os princípios de design de APIs REST e GraphQL para construir APIs intuitivas, escaláveis e sustentáveis que encantam os desenvolvedores e resistem ao teste do tempo.
Use esta skill quando
- Projetando novas APIs REST ou GraphQL
- Refatorando APIs existentes para melhor usabilidade
- Estabelecendo padrões de design de API para sua equipe
- Revisando especificações de API antes da implementação
- Migrando entre paradigmas de API (REST para GraphQL, etc.)
- Criando documentação de API amigável para desenvolvedores
- Otimizando APIs para casos de uso específicos (mobile, integrações de terceiros)
Não use esta skill quando
- Você precisa apenas de orientação de implementação para um framework específico
- Você está fazendo trabalho apenas de infraestrutura sem contratos de API
- Você não pode alterar ou versionar interfaces públicas
Instruções
- Defina consumidores, casos de uso e restrições.
- Escolha o estilo de API e modele recursos ou tipos.
- Especifique erros, versionamento, paginação e estratégia de autenticação.
- Valide com exemplos e revise para consistência.
Consulte resources/implementation-playbook.md para padrões detalhados, listas de verificação e modelos.
Recursos
resources/implementation-playbook.mdpara padrões detalhados, listas de verificação e modelos.