📦

api-patterns

Name: api-patterns
Author: sickn33

Seguro

Desenvolva APIs Melhores com Orientação de Padrões

Construir APIs sem princípios de design claros leva a interfaces inconsistentes e má experiência para desenvolvedores. Esta habilidade fornece árvores de decisão e melhores práticas para escolher o estilo de API correto e implementá-lo adequadamente.

Suporta: Claude Codex Code(CC)

🥉 72 Bronze

Baixar o ZIP da skill

Upload no Claude

Vá em Configurações → Capacidades → Skills → Upload skill

Ative e comece a usar

Testar

A utilizar "api-patterns". Devo usar REST ou GraphQL para um aplicativo móvel com relacionamentos de dados complexos?

Resultado esperado:

GraphQL é mais adequado para seu caso de uso porque: 1) Aplicativos móveis se beneficiam de consultas flexíveis para reduzir over-fetching, 2) Múltiplas plataformas de frontend podem solicitar exatamente o que precisam, 3) Grafos de dados complexos mapeiam naturalmente para o schema GraphQL. No entanto, considere GraphQL se sua equipe estiver familiarizada com ele e você tiver infraestrutura para análise de custo de consulta.

A utilizar "api-patterns". Quais códigos de status HTTP devo usar para um endpoint POST que cria um usuário?

Resultado esperado:

Use 201 Created para criação bem-sucedida do usuário, 400 Bad Request para entrada inválida, 409 Conflict se o e-mail já existir e 500 para erros do servidor. Inclua o usuário criado no corpo da resposta e defina o cabeçalho Location para o URI do novo recurso.

Auditoria de Segurança

Seguro

v1 • 2/24/2026

All 67 static findings are false positives. The skill is a documentation resource for API design patterns. Backticks detected are markdown code formatting, not shell commands. No weak cryptography or reconnaissance tools present.

Arquivos analisados

735

Linhas analisadas

achados

Total de auditorias

Problemas de Risco Médio (1)

api-style.md:7-24 graphql.md:7-41 trpc.md:7-41 rest.md:7-14

Markdown Code Blocks Flagged as Shell Commands

Static analyzer detected backticks in markdown files and flagged them as 'Ruby/shell backtick execution'. These are documentation code blocks for API decision trees and examples, not actual shell commands.

Problemas de Baixo Risco (1)

rest.md:34-38 security-testing.md:59 security-testing.md:102

HTTP Status Code Terms Flagged as Reconnaissance

Security testing documentation mentions standard HTTP status codes (401 Unauthorized, 403 Forbidden) and SSRF testing concepts. These are legitimate API security education topics, not reconnaissance tools.

Auditado por: claude

Pontuação de qualidade

Arquitetura

100

Manutenibilidade

Conteúdo

Comunidade

Segurança

Conformidade com especificações

O Que Você Pode Construir

Escolhendo Arquitetura de API

Desenvolvedor iniciando um novo projeto e precisa decidir entre REST, GraphQL ou tRPC com base na stack de frontend e complexidade dos dados.

Projetando Endpoints REST

Equipe implementando uma API REST e precisa de orientação sobre nomenclatura de recursos, métodos HTTP e uso adequado de códigos de status.

Revisão de Segurança de API

Engenheiro de segurança auditando APIs existentes em busca de vulnerabilidades comuns usando a lista de verificação OWASP API Top 10.

Tente Estes Prompts

Seleção de Estilo de API

Estou construindo um [descreva seu projeto, ex: aplicativo de e-commerce com frontend React e backend Node.js]. Qual estilo de API devo usar? Quais são as compensações?

Design de Endpoint REST

Preciso projetar endpoints REST para [descreva o recurso, ex: gerenciamento de usuários com perfis, posts e comentários]. Mostre-me a estrutura de URL adequada, métodos HTTP e códigos de status.

Tratamento de Erros de API

Qual é a melhor forma de lidar com erros na minha API? Mostre-me o formato de resposta adequado e quais códigos de status HTTP usar para [liste cenários de erro].

Estratégia de Versionamento de API

Como devo versionar minha API? Espero que a API evolua ao longo do tempo. Compare versionamento por URI, versionamento por cabeçalho e versionamento por parâmetro de consulta.

Melhores Práticas

Escolha o estilo de API com base nas necessidades do cliente, não em preferência pessoal - considere a stack de frontend, complexidade dos dados e requisitos de cache
Use envelopes de resposta consistentes e formatos de erro padrão em todos os endpoints
Implemente limitação de taxa desde o início e comunique os limites claramente na documentação da API

Evitar

Usar verbos em endpoints REST (ex: /getUsers em vez de GET /users)
Retornar formatos de resposta diferentes para o mesmo recurso em diferentes endpoints
Expor mensagens de erro internas e stack traces para clientes da API

Perguntas Frequentes

Quando devo escolher REST em vez de GraphQL?

Escolha REST para APIs públicas que precisam de ampla compatibilidade, operações CRUD simples ou quando o cache HTTP é importante. Escolha GraphQL para relacionamentos de dados complexos, múltiplas plataformas de frontend ou quando os clientes precisam de consultas flexíveis.

Qual é a melhor estratégia de versionamento de API?

Versionamento por URI (ex: /v1/users) é o mais comum e visível. Versionamento por cabeçalho é mais limpo mas menos descobrível. Versionamento por consulta (ex: /users?version=1) funciona para mudanças menores mas pode poluir URLs.

Como devo lidar com paginação na minha API?

Use paginação baseada em cursor para conjuntos de dados grandes e scroll infinito. Use paginação baseada em offset para tamanhos de página conhecidos. Inclua contagem total quando útil e forneça links next/previous na resposta.

Qual é a diferença entre os códigos de status 401 e 403?

401 Unauthorized significa que a autenticação está ausente ou inválida. 403 Forbidden significa que a autenticação é válida mas o usuário não tem permissão para o recurso solicitado.

Devo usar autenticação JWT ou baseada em sessão?

JWT é melhor para APIs stateless e microsserviços. Autenticação baseada em sessão funciona bem para aplicativos tradicionais renderizados no servidor. Considere suas necessidades de escalabilidade e tipos de cliente.

Como protejo minha API de ataques comuns?

Implemente limitação de taxa, valide toda entrada, use consultas parametrizadas, implemente verificações de autorização adequadas (BOLA), desative introspecção em produção e siga as diretrizes OWASP API Top 10.