api-documentation
Faz seu agente gerenciar a documentação de APIs. Ele cria especificações e guias para que a documentação esteja sempre completa e atualizada.
O que ela faz
Esta ferramenta ajuda a criar toda a documentação para uma API (interface que permite que diferentes softwares conversem entre si). Isso inclui especificações técnicas, guias para desenvolvedores e exemplos de código.
Quando usar
- ✓Quando você está criando a documentação de uma API pela primeira vez.
- ✓Ao precisar gerar um arquivo de especificação técnica (OpenAPI/Swagger).
- ✓Para escrever um guia que ensine outros desenvolvedores a usar sua API.
Exemplo do que pedir para a IA
“Crie a documentação completa para a minha API de usuários, incluindo a especificação OpenAPI, um guia para desenvolvedores e exemplos de código.”
Quer saber mais? Abra as seções abaixo.
Como usar
O jeito mais fácil: copie a mensagem abaixo e cole no Claude, ChatGPT, Cursor ou outra IA. Ela lê a skill e segue as instruções.
Link da skill
Mensagem pronta para colar
Como funciona
A ferramenta organiza o trabalho em etapas, como descobrir os detalhes da API, criar a especificação técnica, escrever o guia, adicionar exemplos e configurar a visualização interativa.
Instalação
Jeito mais fácil: copie o link da skill e cole no Claude, ChatGPT ou Cursor pedindo para seguir as instruções.
No terminal (Claude Code, Codex, Cursor), na pasta do projeto:
npx skills add sickn33/agentic-awesome-skills --skill api-documentationOu baixe só o arquivo:
curl -L https://raw.githubusercontent.com/sickn33/agentic-awesome-skills/main/plugins/agentic-awesome-skills-claude/skills/api-documentation/SKILL.md -o SKILL.mdConteúdo técnico (SKILL.md)
Tradução do texto original do autor no GitHub. Os comandos e códigos estão como no original.
Documentação de API: Fluxo de Trabalho
Visão Geral
Fluxo de trabalho especializado para criar documentação abrangente de API, incluindo especificações OpenAPI/Swagger, guias para desenvolvedores, exemplos de código e documentação interativa.
Quando Usar Este Fluxo de Trabalho
Use este fluxo de trabalho quando:
- Criar documentação de API
- Gerar especificações OpenAPI
- Escrever guias para desenvolvedores
- Adicionar exemplos de código
- Configurar portais de API
Escopo e Execução
Escolha as fases que correspondem à tarefa do usuário; este documento é um índice, não uma instrução para executar todas as habilidades listadas. Leia uma habilidade selecionada antes de usá-la. Respeite as restrições de repositório e de usuário. Chamadas na nuvem, configuração de host, publicação, operações destrutivas e gastos exigem autorização aplicável; um checklist de fluxo de trabalho não concede isso.
Baseie o contrato na implementação/especificação real e mantenha segredos fora dos exemplos. "Experimente" pode enviar requisições reais: use endpoints de sandbox explícitos e credenciais de teste. Visualize a documentação localmente antes de publicar; a implantação é uma ação autorizada separada.
Fases do Fluxo de Trabalho
Fase 1: Descoberta de API
Habilidades a Invocar
api-documenter- Documentação de APIapi-design-principles- Design de API
Ações
- Inventariar endpoints
- Documentar requisição/resposta
- Identificar autenticação
- Mapear códigos de erro
- Anotar limites de taxa
Prompts para Copiar e Colar
Use @api-documenter to discover and document API endpoints
Fase 2: Especificação OpenAPI
Habilidades a Invocar
openapi-spec-generation- OpenAPIapi-documenter- Especificações de API
Ações
- Criar esquema OpenAPI
- Definir caminhos
- Adicionar esquemas
- Configurar segurança
- Adicionar exemplos
Prompts para Copiar e Colar
Use @openapi-spec-generation to create OpenAPI specification
Fase 3: Guia para Desenvolvedores
Habilidades a Invocar
api-documentation-generator- Documentaçãodocumentation-templates- Modelos
Ações
- Criar introdução (getting started)
- Escrever guia de autenticação
- Documentar padrões comuns
- Adicionar solução de problemas
- Criar FAQ
Prompts para Copiar e Colar
Use @api-documentation-generator to create developer guide
Fase 4: Exemplos de Código
Habilidades a Invocar
api-documenter- Exemplos de códigotutorial-engineer- Tutoriais
Ações
- Criar exemplos de requisições
- Escrever exemplos de SDK
- Adicionar exemplos de curl
- Criar tutoriais
- Testar exemplos
Prompts para Copiar e Colar
Use @api-documenter to generate code examples
Fase 5: Docs Interativas
Habilidades a Invocar
api-documenter- Docs interativas
Ações
- Configurar Swagger UI
- Configurar Redoc
- Adicionar funcionalidade "experimente"
- Testar interatividade
- Implantar docs
Prompts para Copiar e Colar
Use @api-documenter to set up interactive documentation
Fase 6: Site de Documentação
Habilidades a Invocar
docs-architect- Arquitetura de documentaçãowiki-page-writer- Documentação
Ações
- Escolher plataforma
- Projetar estrutura
- Criar páginas
- Adicionar navegação
- Configurar busca
Prompts para Copiar e Colar
Use @docs-architect to design API documentation site
Fase 7: Manutenção
Habilidades a Invocar
api-documenter- Manutenção de docs
Ações
- Configurar geração automática
- Configurar validação
- Adicionar processo de revisão
- Agendar atualizações
- Monitorar feedback
Prompts para Copiar e Colar
Use @api-documenter to set up automated doc generation
Portões de Qualidade
- Especificação OpenAPI completa
- Guia para desenvolvedores escrito
- Exemplos de código funcionando
- Docs interativas funcionais
- Documentação implantada
Pacotes de Fluxo de Trabalho Relacionados
documentation- Documentaçãoapi-design-principles- Design de contrato de APIdevelopment- Desenvolvimento
Limitações
- Use esta habilidade apenas quando a tarefa corresponder claramente ao escopo descrito acima.
- Não trate a saída como substituta para validação específica do ambiente, testes ou revisão especializada.
- Pare e peça esclarecimentos se as entradas necessárias, permissões, limites de segurança ou critérios de sucesso estiverem ausentes.
Perguntas frequentes
O que é uma API?
API é como um cardápio em um restaurante. Ele diz quais pratos (funções) estão disponíveis e como pedi-los (usar a função), sem que você precise saber como a cozinha (o software) funciona por dentro.
O que é OpenAPI/Swagger?
É um formato padrão para descrever APIs. Pense nele como um 'manual de instruções' técnico que outras ferramentas podem ler para entender e interagir com a sua API.
Posso usar isso para criar a documentação de qualquer software?
Esta ferramenta é focada especificamente em documentação de APIs. Para outros tipos de software, pode ser necessário usar outras ferramentas.
Detalhes
Descrição original do autor
API documentation workflow for generating OpenAPI specs, creating developer guides, and maintaining comprehensive API documentation.
Popularidade
- Estrelas no GitHub
- 48 mil
- Posição no ranking
- #2155
- Licença
- MIT
- Atualizada em
- 15/10/2026
Comentários
- …
Mais skills deste repositório
00-andruia-consultant
Ajuda seu agente a iniciar ou melhorar projetos de IA. Ele analisa código, sugere ferramentas e cria planos de ação em espanhol.
sickn33/agentic-awesome-skills
007
Faz seu agente realizar auditorias de segurança e modelagem de ameaças. É útil para proteger projetos contra ataques e vulnerabilidades.
sickn33/agentic-awesome-skills
10-andruia-skill-smith
Ajuda seu agente a criar ou melhorar ferramentas de IA. Ele define como as ferramentas funcionam, escreve a documentação e valida a estrutura.
sickn33/agentic-awesome-skills
20-andruia-niche-intelligence
Faz seu agente criar um resumo sobre um setor específico. É útil para entender o contexto, regras, padrões de uso e riscos de um projeto, usando fontes confiáveis.
sickn33/agentic-awesome-skills
Skills parecidas
architecture-decision-records
Faz seu agente registrar decisões importantes sobre a estrutura do projeto. Ajuda a entender o porquê das escolhas feitas e a manter um histórico claro das mudanças.
affaan-m/ECC
code-tour
Faz seu agente criar guias passo a passo no código, com locais exatos em arquivos e linhas. É útil para apresentar um projeto, explicar código ou revisar mudanças. Ajuda a entender como um sistema funciona.
affaan-m/ECC
codebase-onboarding
Ajuda seu agente a analisar um código desconhecido e criar um guia de integração. Ele inclui um mapa da arquitetura, pontos de entrada e convenções. Ideal para quem está começando em um novo projeto.
affaan-m/ECC