API Documenter
Gerar Documentação de API
Desenvolvedores gastam horas escrevendo documentação de API manualmente. Esta skill automatiza a criação de documentação completa de APIs a partir de código ou especificações OpenAPI, economizando tempo e garantindo consistência.
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 Documenter". Gerar documentação de API para um endpoint GET /users/{id} que retorna dados de perfil de usuário
Resultado esperado:
- # GET /users/{id}
- Recupera um perfil de usuário por identificador único.
- ## Solicitação
- - Método: GET
- - Caminho: /users/{id}
- - Autenticação: Token Bearer necessário
- ## Resposta 200
- ```json
- {"id": "user_123", "name": "John Doe", "email": "john@example.com"}
- ```
A utilizar "API Documenter". Documentar esta especificação OpenAPI para uma API de pets
Resultado esperado:
- # API Pet Store
- ## Visão Geral
- API RESTful para gerenciar inventário de pets.
- ## Endpoints
- - GET /pets - Listar pets
- - POST /pets - Adicionar pet
- - GET /pets/{id} - Obter pet
- - DELETE /pets/{id} - Remover pet
Auditoria de Segurança
SeguroThis is a prompt-only skill that generates API documentation. Static analysis found no executable code, no network requests, no filesystem access, and no external command execution. The skill contains only natural language prompts for generating documentation content.
Pontuação de qualidade
O Que Você Pode Construir
Documentação Rápida de API para Serviços Internos
Gerar rapidamente documentação para microsserviços internos durante sprints de desenvolvimento
Documentação de API Pública
Criar documentação polida e voltada ao usuário para produtos de API pública
Recuperação de Documentação de API Legada
Gerar documentação para APIs legadas não documentadas analisando o código
Tente Estes Prompts
Gerar documentação de API para o seguinte endpoint: [cole o código ou descrição do endpoint]
Criar documentação completa de API para esta especificação OpenAPI: [cole o JSON/YAML do OpenAPI]
Gerar documentação de API com exemplos de código em Python, JavaScript e curl para: [cole detalhes do endpoint]
Criar documentação de API em markdown polido com seções para visão geral, endpoints, autenticação, códigos de erro e exemplos: [cole a especificação da API]
Melhores Práticas
- Fornecer especificações OpenAPI completas para melhores resultados
- Incluir detalhes de autenticação na entrada
- Revisar os exemplos gerados quanto à precisão antes de publicar
Evitar
- Esperar testes em tempo real de endpoints de API
- Fornecer descrições de endpoints incompletas ou ambíguas
- Assumir que a skill conhece suas convenções internas específicas