Revisor de Design de API
PROAudite APIs REST e GraphQL pra consistência, escalabilidade, segurança e aderência a melhores práticas antes do deploy.
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 to organizational API style guide for validation | https://opensource.zalando.com/restful-api-guidelines/ | |
| Default records per page for pagination review | 20 | |
| Maximum allowed records per request | 1000 | |
| Required authentication mechanism | oauth2 | |
| Maximum allowed GraphQL query complexity score | 1000 | |
| Time window for rate limiting | 3600 |
Audit REST and GraphQL APIs for consistency, scalability, security, and adherence to best practices. Get detailed review reports with actionable recommendations before deployment.
Fontes de Pesquisa
Este skill foi criado usando pesquisa destas fontes confiáveis:
- Enhancing Data Query Flexibility with GraphQL GraphQL vs REST performance characteristics and schema optimization
- REST API Design and Specification Practices Empirical research on real-world API design challenges
- Performance Evaluation of Microservices Communication Benchmark comparing REST, GraphQL, and gRPC performance
- How to Conduct API Design Reviews Practical guide on implementing API review processes
- API Design Patterns for Scalable Systems Resource-based patterns, pagination, and scalability approaches
- GraphQL API Design Best Practices GraphQL-specific schema optimization and error handling
- API Design Reviews Don't Have to be Hard Systematic review methodology and documentation assessment
- OpenAPI Specification v3.1.0 Official machine-readable API description standard
