lucasfdigital/api-patterns
skills/api-patterns/SKILL.md
Princípios de design de API e tomada de decisão. Seleção entre REST vs GraphQL vs tRPC, formatos de resposta, versionamento e paginação.
development
Updated Apr 27, 2026
$ install --global
skillsauthnpx skillsauth add lucasfdigital/orchard api-patternsInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 27, 2026, 10:57 AM58.0s12 files scanned
SKILL.md
- name:
- api-patterns
- description:
- Princípios de design de API e tomada de decisão. Seleção entre REST vs GraphQL vs tRPC, formatos de resposta, versionamento e paginação.
- allowed-tools:
- Read, Write, Edit, Glob, Grep
Padrões de API
Princípios de design de API e tomada de decisão para 2025. Aprenda a PENSAR, não apenas a copiar padrões fixos.
🎯 Regra de Leitura Seletiva
Leia APENAS os arquivos relevantes para a solicitação! Verifique o mapa de conteúdo e encontre o que precisa.
📑 Mapa de Conteúdo
| Arquivo | Descrição | Quando Ler |
| :--- | :--- | :--- |
| api-style.md | Árvore de decisão: REST vs GraphQL vs tRPC | Ao escolher o tipo de API |
| rest.md | Nomenclatura de recursos, métodos HTTP, códigos de status | Ao projetar uma API REST |
| response.md | Padrão envelope, formato de erro, paginação | Estrutura de resposta |
| graphql.md | Design de schema, quando usar, segurança | Ao considerar GraphQL |
| trpc.md | Monorepo TypeScript, type safety | Projetos TS fullstack |
| versioning.md | Versionamento por URI/Header/Query | Planejamento da evolução da API |
| auth.md | JWT, OAuth, Passkey, Chaves de API | Seleção de padrão de autenticação |
| rate-limiting.md | Token bucket, sliding window | Proteção da API |
| documentation.md | Melhores práticas de OpenAPI/Swagger | Documentação |
| security-testing.md | OWASP API Top 10, testes de auth/authz | Auditorias de segurança |
🔗 Skills Relacionadas
| Necessidade | Skill |
| :--- | :--- |
| Implementação de API | @[skills/backend-development] |
| Estrutura de dados | @[skills/database-design] |
| Detalhes de segurança | @[skills/security-hardening] |
✅ Checklist de Decisão
Antes de projetar uma API:
- [ ] Perguntou ao usuário sobre os consumidores da API?
- [ ] Escolheu o estilo de API para ESTE contexto? (REST/GraphQL/tRPC)
- [ ] Definiu um formato de resposta consistente?
- [ ] Planejou a estratégia de versionamento?
- [ ] Considerou as necessidades de autenticação?
- [ ] Planejou o rate limiting (limite de taxa)?
- [ ] Abordagem de documentação definida?
❌ Anti-Padrões
NÃO FAÇA:
- Usar REST como padrão para tudo.
- Usar verbos em endpoints REST (/getUsers).
- Retornar formatos de resposta inconsistentes.
- Expor erros internos para os clientes.
- Pular o rate limiting.
FAÇA:
- Escolha o estilo da API com base no contexto.
- Pergunte sobre os requisitos do cliente.
- Documente minuciosamente.
- Use códigos de status apropriados.
Script
| Script | Propósito | Comando |
| :--- | :--- | :--- |
| scripts/api_validator.py | Validação de endpoints de API | python scripts/api_validator.py <caminho_do_projeto> |
Related Skills
lucasfdigital/webapp-testing
development
VerifiedTrustedCommunity
Princípios de teste de aplicações web. E2E, Playwright, estratégias de auditoria profunda.
SKILL.mdUpdated Apr 27, 2026
lucasfdigital/web-design-guidelines
development
VerifiedTrustedCommunity
Revisar o código da UI para conformidade com as Web Interface Guidelines. Use quando solicitado para "revisar minha UI", "checar acessibilidade", "auditar design", "revisar UX" ou "verificar meu site em relação às melhores práticas".
SKILL.mdUpdated Apr 27, 2026
lucasfdigital/vulnerability-scanner
testing
VerifiedTrustedCommunity
Princípios avançados de análise de vulnerabilidade. OWASP 2025, Segurança da Cadeia de Suprimentos (Supply Chain), mapeamento de superfície de ataque e priorização de riscos.
SKILL.mdUpdated Apr 27, 2026
lucasfdigital/testing-patterns
testing
VerifiedTrustedCommunity
Padrões e princípios de teste. Estratégias de testes unitários, de integração e mocking.
SKILL.mdUpdated Apr 27, 2026