Skip to content

artubss/SKILLS-CLAUDE-CODE / skills/skills/development/api-patterns

api-patterns

Unverified

Princípios de design de API e tomada de decisão. Seleção REST vs GraphQL vs tRPC, formatos de resposta, versionamento, paginação.

Padrões de API

Princípios de design de API e tomada de decisão para 2025. Aprenda a PENSAR, não copie padrões fixos.

🎯 Regra de Leitura Seletiva

Leia APENAS os arquivos relevantes para a solicitação! Verifique o mapa de conteúdo, encontre o que você precisa.


📑 Mapa de Conteúdo

ArquivoDescriçãoQuando Ler
api-style.mdÁrvore de decisão REST vs GraphQL vs tRPCEscolhendo tipo de API
rest.mdNomenclatura de recursos, métodos HTTP, códigos de statusProjetando API REST
response.mdPadrão envelope, formato de erro, paginaçãoEstrutura de resposta
graphql.mdDesign de schema, quando usar, segurançaConsiderando GraphQL
trpc.mdMonorepo TypeScript, segurança de tipoProjetos fullstack TS
versioning.mdVersionamento por URI/Header/QueryPlanejamento de evolução de API
auth.mdJWT, OAuth, Passkey, API KeysSeleção de padrão de autenticação
rate-limiting.mdToken bucket, janela deslizanteProteção de API
documentation.mdMelhores práticas OpenAPI/SwaggerDocumentação
security-testing.mdOWASP API Top 10, testes de autenticação/autorizaçãoAuditorias de segurança

🔗 Habilidades Relacionadas

NecessidadeHabilidade
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 formato de resposta consistente?
  • Planejou estratégia de versionamento?
  • Considerou necessidades de autenticação?
  • Planejou rate limiting?
  • Abordagem de documentação definida?

❌ Anti-Padrões

NÃO FAÇA:

  • Use REST por padrão para tudo
  • Use verbos em endpoints REST (/getUsers)
  • Retorne formatos de resposta inconsistentes
  • Exponha erros internos aos clientes
  • Pule rate limiting

FAÇA:

  • Escolha o estilo de API baseado no contexto
  • Pergunte sobre os requisitos do cliente
  • Documente minuciosamente
  • Use códigos de status apropriados

Script

ScriptPropósitoComando
scripts/api_validator.pyValidação de endpoint de APIpython scripts/api_validator.py <project_path>
brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation).Stars: 318kUpdated Claude CodeCodexUnverifiedInstall
brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply.Stars: 196kUpdated Claude CodeCodexVerifiedInstall
frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults.Stars: 196kUpdated Claude CodeCodexVerifiedInstall
mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK).Stars: 196kUpdated Claude CodeCodexVerifiedInstall