Compétences api-documentation-generator
📚

api-documentation-generator

Sûr

Gerar Documentação Profissional de API

Également disponible depuis: CrazyDubya

Pare de escrever documentação de API manualmente e mantê-la desatualizada. Esta habilidade gera automaticamente documentação abrangente e amigável para desenvolvedores a partir do seu código com exemplos funcionais.

Prend en charge: Claude Codex Code(CC)
🥉 74 Bronze
1

Télécharger le ZIP du skill

2

Importer dans Claude

Allez dans Paramètres → Capacités → Skills → Importer un skill

3

Activez et commencez à utiliser

Tester

Utilisation de "api-documentation-generator". Documentar um endpoint POST /users que cria contas de usuário

Résultat attendu:

  • ## Criar Usuário
  • Cria uma nova conta de usuário.
  • Endpoint: POST /api/v1/users
  • Autenticação: Obrigatória (Bearer token)
  • Corpo da Requisição: email (obrigatório), password (obrigatório, mínimo 8 caracteres), name (obrigatório)
  • Resposta de Sucesso: 201 Created com objeto de usuário incluindo id, email, name, createdAt
  • Respostas de Erro: 400 Validation Error, 409 Email Exists, 401 Unauthorized
  • Exemplos fornecidos em cURL, JavaScript fetch e Python requests

Utilisation de "api-documentation-generator". Documentar query GraphQL GetUser com parâmetro ID

Résultat attendu:

  • ## Query de Usuário
  • Busca informações do usuário por ID.
  • Query: GetUser($id: ID!) retorna objeto de usuário com id, email, name, role, posts
  • Variáveis: id (obrigatório, tipo ID)
  • Resposta: Objeto de dados contendo usuário com array aninhado de posts
  • Erros: USER_NOT_FOUND com código de extensão e userId

Audit de sécurité

Sûr
v1 • 2/24/2026

This skill is a documentation generator that produces API documentation from codebases. Static analysis flagged 65 external_commands and 12 network patterns, but all are FALSE POSITIVES. The SKILL.md file contains only instructional markdown with code examples formatted using markdown backticks (not shell execution). URLs are documentation examples (api.example.com), not actual network calls. No executable code, no cryptographic implementations, and no system commands exist. Safe for publication.

1
Fichiers analysés
487
Lignes analysées
0
résultats
1
Total des audits
Aucun problème de sécurité trouvé
Audité par: claude

Score de qualité

38
Architecture
100
Maintenabilité
87
Contenu
50
Communauté
100
Sécurité
91
Conformité aux spécifications

Ce que vous pouvez construire

Documentação de API REST

Gere documentação completa de endpoints para APIs REST com exemplos de requisição/resposta, detalhes de autenticação e códigos de erro

Documentação de Schema GraphQL

Crie documentação de queries e mutations com especificações de variáveis, estruturas de resposta e formatos de erro

Conteúdo para Portal do Desenvolvedor

Produza documentação de referência de API abrangente incluindo guias de introdução, configuração de autenticação e diretrizes de uso

Essayez ces prompts

Documentação Básica de Endpoint 
Documente este endpoint de API: [paste code]. Inclua o método HTTP, caminho da URL, parâmetros de requisição, formato de resposta e um exemplo de código.
Referência Completa de API 
Gere documentação completa de API para este codebase: [paste files]. Inclua todos os endpoints, requisitos de autenticação, schemas de requisição/resposta, códigos de erro e exemplos de código em cURL, JavaScript e Python.
Geração de Especificação OpenAPI 
Converta este código de API em uma especificação OpenAPI 3.0: [paste code]. Inclua todos os paths, componentes, security schemes e valores de exemplo.
Atualização de Documentação a Partir de Mudanças no Código 
Atualize a documentação da API com base nestas mudanças no código: [show diff]. Identifique novos endpoints, parâmetros modificados e formatos de resposta alterados. Forneça seções de documentação atualizadas.

Bonnes pratiques

  • Mantenha a documentação próxima ao código usando comentários ou anotações para garantir sincronização
  • Inclua exemplos de código funcionais testados contra um ambiente sandbox ou staging
  • Documente todos os códigos de erro e casos de borda, não apenas cenários de sucesso

Éviter

  • Escrever exemplos de documentação com dados de placeholder como foo e bar em vez de valores realistas
  • Documentar apenas cenários happy path sem cobrir tratamento de erros
  • Criar documentação como um artefato separado que é esquecido quando o código muda

Foire aux questions

Quais linguagens de programação esta habilidade suporta?
Esta habilidade pode documentar APIs escritas em qualquer linguagem. Ela gera exemplos de documentação em cURL, JavaScript, Python e outras linguagens conforme necessário.
Isso pode gerar especificações OpenAPI/Swagger?
Sim. Forneça seu código de API e esta habilidade gerará um arquivo de especificação OpenAPI 3.0 válido que pode ser usado com Swagger UI ou ferramentas similares.
Esta habilidade testa os endpoints documentados?
Não. Esta habilidade gera documentação a partir de análise de código, mas não executa ou valida endpoints. Teste exemplos no seu ambiente de staging.
Isso pode documentar APIs GraphQL?
Sim. Esta habilidade documenta queries, mutations e subscriptions do GraphQL com especificações de variáveis, estruturas de resposta e formatos de erro.
Como manter a documentação atualizada quando minha API muda?
Execute esta habilidade novamente com seu código atualizado. Para melhores resultados, integre a geração de documentação no seu pipeline de CI/CD.
Isso pode criar coleções do Postman?
Sim. Esta habilidade pode gerar arquivos JSON de coleção do Postman que incluem todos os endpoints documentados com requisições de exemplo.

Détails du développeur

Auteur

sickn33

Licence

MIT

Dépôt

https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/api-documentation-generator

Réf

main

Structure de fichiers

📄 SKILL.md