designing-apis
Projete APIs REST e GraphQL com as melhores práticas
Criar APIs sem padrões de design claros leva a endpoints inconsistentes e uma experiência ruim para desenvolvedores. Esta skill fornece orientação abrangente para projetar APIs REST e GraphQL com endpoints padronizados, tratamento adequado de erros, estratégias de versionamento e modelos de documentação OpenAPI.
Скачать ZIP навыка
Загрузить в Claude
Перейдите в Settings → Capabilities → Skills → Upload skill
Включите и начните использовать
Протестировать
Использование «designing-apis». Design a REST API for a task management app
Ожидаемый результат:
- Endpoints: GET /tasks, POST /tasks, GET /tasks/:id, PATCH /tasks/:id, DELETE /tasks/:id
- Formato de resposta inclui wrapper de dados com requestId para rastreamento
- Respostas de erro contêm code, message e detalhes em nível de campo
- Versionamento via URL: /api/v1/tasks
- Headers de limitação de taxa: X-RateLimit-Limit, X-RateLimit-Remaining, Retry-After
Использование «designing-apis». Create a GraphQL schema for a blog
Ожидаемый результат:
- Query type com campos posts, post e author
- Mutation type com operações createPost e addComment
- Post type com campos id, title, content, author e comments
- Suporte a paginação via argumentos first e after
- Input types para criar posts e adicionar comentários
Использование «designing-apis». Design authentication patterns for my API
Ожидаемый результат:
- JWT Bearer Token: Authorization: Bearer <token>
- API Key: X-API-Key: <key>
- Ambos os esquemas definidos em OpenAPI components securitySchemes
- Aplicar requisitos de segurança no nível de especificação ou por endpoint
Аудит безопасности
БезопасноPure documentation skill containing only markdown files with API design guidance, templates, and best practices. No executable code, scripts, network calls, or filesystem access beyond reading its own documentation files. All static findings are false positives: markdown code block delimiters were misidentified as shell backticks, example URLs flagged as hardcoded URLs are non-sensitive placeholders, JWT references flagged as weak cryptography are standard API authentication patterns, and HTTP method documentation was misidentified as system reconnaissance.
Факторы риска
⚙️ Внешние команды (26)
🌐 Доступ к сети (2)
Оценка качества
Что вы можете построить
Projete novos endpoints de API
Crie designs de API REST e GraphQL consistentes seguindo as melhores práticas da indústria
Planeje arquitetura de API
Defina contratos de API, estratégias de versionamento e padrões de documentação
Revise designs de API
Valide contratos de API contra padrões de design estabelecidos
Попробуйте эти промпты
Design a REST API for user management including list, create, get, update, and delete operations
Create a GraphQL schema for an e-commerce app with products, orders, and user types
Write an OpenAPI 3.0 specification for a blog API with posts, comments, and authors
Design a comprehensive error handling strategy for a REST API including status codes and error response formats
Лучшие практики
- Use substantivos, não verbos, em URLs de endpoint para APIs REST
- Aplique envelopes de resposta consistentes em todos os endpoints
- Inclua parâmetros de paginação e filtragem para endpoints de listagem
- Documente todos os requisitos de autenticação nas especificações OpenAPI
Избегать
- Usar verbos em URLs como /getUsers ou /createPost
- Retornar formatos de resposta diferentes para sucesso vs erro
- Expor dados sensíveis em parâmetros de URL
- Pular versionamento e introduzir mudanças que quebram compatibilidade sem aviso