CommunityEscrita e Ediçãogithub.com

divlook/agent-skill-api-radar

Habilidade de agente que analisa endpoints de API de repositórios GitHub e gera documentação estruturada.

O que é agent-skill-api-radar?

Esta habilidade permite que agentes de IA, como Claude Code, Cursor ou Codex, analisem automaticamente os endpoints de API de um repositório GitHub e gerem documentação estruturada e de alta qualidade. É útil para desenvolvedores que precisam entender rapidamente a superfície de API de um projeto, especialmente em codebases grandes ou não documentados. A habilidade funciona escaneando o código-fonte do repositório, identificando padrões de definição de API (como rotas, métodos HTTP, parâmetros e respostas) e compilando essas informações em um formato de documentação claro e organizado (por exemplo, Markdown ou OpenAPI). A saída pode ser usada diretamente em wikis, READMEs ou ferramentas de documentação, economizando horas de trabalho manual.

Funciona com~Claude Code~Codex CLI~Cursor
npx skills add divlook/agent-skill-api-radar

Installed? Explore more Escrita e Edição skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

Perguntar na sua IA favorita

Abre um novo chat com esta habilidade de agente já pré-carregada.

Documentação

O que agent-skill-api-radar faz?

Habilidade de agente que analisa endpoints de API de repositórios GitHub e gera documentação estruturada.

Visão Geral

Esta habilidade permite que agentes de IA escaneiem automaticamente um repositório GitHub, identifiquem todos os endpoints de API (baseados em frameworks como Express, FastAPI, Rails, etc.) e produzam documentação em formato Markdown ou OpenAPI/Swagger.

Como usar

  1. Forneça a URL do repositório GitHub.
  2. A habilidade clona ou acessa o código-fonte.
  3. Ela analisa rotas, métodos HTTP, parâmetros de consulta, corpos de requisição e formatos de resposta.
  4. Gera a documentação em um arquivo de saída (ex: API.md).

Exemplo de saída

# Endpoints

## GET /users

- **Descrição**: Retorna uma lista de usuários.
- **Parâmetros**:
  - `page` (inteiro, opcional): Número da página.
  - `limit` (inteiro, opcional): Limite de resultados.
- **Resposta**:
  - `200`: Array de objetos de usuário.

Requisitos

  • Acesso ao repositório GitHub (público ou com token).
  • Node.js, Python ou runtime compatível com a análise.

Plataformas compatíveis

  • Claude Code
  • Cursor
  • Codex
  • Outros agentes com capacidade de execução de scripts.

Habilidades Relacionadas