Revisor de Design de APIs
PROAudita APIs REST e GraphQL quanto a consistência, escalabilidade, segurança e adesão a melhores práticas antes de deployment.
Exemplo de Uso
Revise este design de API REST para um serviço de gerenciamento de usuários. O endpoint é GET /api/v1/users/{id}/profile. Verifique consistência com convenções de nomes RESTful, valide os códigos de status HTTP apropriados, confirme que a estrutura de resposta de erro segue o formato RFC 9457 Problem Details, e sinalize preocupações de segurança como campos sensíveis expostos.
Prompt do Skill
Este skill funciona melhor quando copiado do findskill.ai — inclui variáveis e formatação que podem não ser transferidas corretamente de outros lugares.
Como Usar Este Skill
1
Copiar o skill usando o botão acima
2
Colar no seu assistente de IA (Claude, ChatGPT, etc.)
3
Preencha suas informações abaixo (opcional) e copie para incluir com seu prompt
4
Envie e comece a conversar com sua IA
Personalização Sugerida
| Descrição | Padrão | Seu Valor |
|---|---|---|
| URL do guia de estilo de API da sua organização para validação | https://opensource.zalando.com/restful-api-guidelines/ | |
| Registros padrão por página para revisão de paginação | 20 | |
| Máximo de registros permitidos por requisição | 1000 | |
| Mecanismo de autenticação obrigatório | oauth2 | |
| Score máximo de complexidade de queries GraphQL | 1000 | |
| Janela de tempo para rate limiting | 3600 |
Audite APIs REST e GraphQL para consistência, escalabilidade, segurança e aderência às melhores práticas. Receba relatórios de revisão detalhados com recomendações acionáveis antes do deploy.
Fontes de Pesquisa
Este skill foi criado usando pesquisa destas fontes confiáveis:
- Enhancing Data Query Flexibility with GraphQL Características de performance GraphQL vs REST e otimização de schemas
- REST API Design and Specification Practices Pesquisa empírica sobre desafios reais de design de APIs
- Performance Evaluation of Microservices Communication Benchmark comparando performance de REST, GraphQL e gRPC
- How to Conduct API Design Reviews Guia prático sobre implementação de processos de revisão de APIs
- API Design Patterns for Scalable Systems Padrões baseados em recursos, paginação e abordagens de escalabilidade
- GraphQL API Design Best Practices Otimização de schema específica de GraphQL e tratamento de erros
- API Design Reviews Don't Have to be Hard Metodologia sistemática de revisão e avaliação de documentação
- OpenAPI Specification v3.1.0 Padrão oficial de descrição de APIs legível por máquinas