Gerador de Documentacao API

Gera documentacao API elegante a partir de OpenAPI ou comentarios anotados

Cria documentacao HTML, Markdown ou PDF com parametros, corpo de requisicao, exemplos de resposta e erros.

Exemplos de resultados

2 Exemplos

Gerar documentacao Markdown a partir de OpenAPI

Converte um documento OpenAPI compacto em referencia Markdown com parametros, respostas, schemas e erros.

# Demo User API

Version: 1.2.0

## Endpoints

### GET /users/{id}

**Summary:** Get user by ID

Ver parâmetros de entrada

{ "sourceText": "{\n \"openapi\": \"3.0.0\",\n \"info\": {\n \"title\": \"Demo User API\",\n \"version\": \"1.2.0\",\n \"description\": \"User management endpoints\"\n },\n \"servers\": [\n {\n \"url\": \"https://api.example.com\"\n }\n ],\n \"paths\": {\n \"/users/{id}\": {\n \"get\": {\n \"summary\": \"Get user by ID\",\n \"tags\": [\n \"users\"\n ],\n \"parameters\": [\n {\n \"in\": \"path\",\n \"name\": \"id\",\n \"required\": true,\n \"description\": \"User identifier\",\n \"schema\": {\n \"type\": \"string\",\n \"example\": \"u_123\"\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"User payload\",\n \"content\": {\n \"application/json\": {\n \"example\": {\n \"id\": \"u_123\",\n \"name\": \"Ada\"\n }\n }\n }\n },\n \"404\": {\n \"description\": \"User not found\"\n }\n }\n }\n }\n },\n \"components\": {\n \"schemas\": {\n \"User\": {\n \"type\": \"object\",\n \"required\": [\n \"id\",\n \"name\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}", "sourceFormat": "json", "outputFormat": "markdown", "documentTitle": "Demo User API", "theme": "slate", "includeExamples": true, "includeSchemas": true }

Renderizar comentarios anotados como HTML interativo

Usa tags de comentarios estruturados para montar uma pagina HTML sem exemplos e schemas.

POST/invoices

Create invoice

Ver parâmetros de entrada

{ "sourceText": "@title Billing API\n@version 0.9.0\n@description Lightweight annotated API example\n@route POST /invoices\n@summary Create invoice\n@tag billing\n@query customerId string - Customer identifier\n@bodyparam amount number optional - Requested invoice total\n@request {\"customerId\":\"cust_1\",\"amount\":129.5}\n@response 201 Created\n@error 422 Validation failed", "sourceFormat": "comments", "outputFormat": "html", "documentTitle": "Billing API", "theme": "paper", "includeExamples": false, "includeSchemas": false }

Fonte da API *

Formato de origem

Formato de saida

Titulo do documento

Tema

Incluir exemplos

Incluir schemas

Fatos principais

Categoria: Desenvolvimento e Web
Tipos de entrada: textarea, select, text, checkbox
Tipo de saída: file
Cobertura de amostras: 4
API disponível: Yes

Visão geral

O Gerador de Documentação API é uma ferramenta prática que converte especificações OpenAPI (JSON ou YAML) e comentários anotados em documentações elegantes e legíveis. Ideal para desenvolvedores e equipes técnicas, ele permite exportar referências de API em formatos como HTML interativo, Markdown ou PDF, incluindo parâmetros, corpos de requisição, exemplos de resposta e códigos de erro de forma estruturada.

Quando usar

•Quando precisar compartilhar especificações de API com clientes ou equipes de front-end em um formato legível.
•Para converter rapidamente arquivos OpenAPI JSON ou YAML em arquivos Markdown para repositórios do GitHub.
•Ao gerar documentação estática em HTML ou PDF a partir de comentários estruturados no código-fonte.

Como funciona

•Cole o seu código OpenAPI (JSON/YAML) ou comentários anotados no campo de texto principal.
•Selecione o formato de saída desejado, como HTML interativo, Markdown ou PDF.
•Personalize o título do documento, escolha um tema visual (Lousa ou Papel) e defina se deseja incluir exemplos e schemas.
•Gere e baixe o arquivo final com a documentação da API formatada e pronta para uso.

Casos de uso

Criação de portais de desenvolvedores com documentação HTML interativa.

Atualização de arquivos README.md em repositórios com a referência completa da API em Markdown.

Geração de manuais de integração em PDF para envio a parceiros comerciais.

Exemplos

1. Gerar documentação Markdown a partir de OpenAPI

Desenvolvedor Backend

Contexto: A equipe precisa atualizar a documentação da API de usuários no repositório do GitHub.
Problema: O arquivo OpenAPI JSON é difícil de ler diretamente no repositório e precisa ser convertido para Markdown.
Como usar: Cole o JSON do OpenAPI, defina o 'Formato de saída' como Markdown e marque as opções para incluir exemplos e schemas.
Configuração de exemplo: Formato de origem: OpenAPI JSON | Formato de saída: Markdown | Tema: Lousa | Incluir exemplos: Sim
Resultado: Um arquivo Markdown estruturado com endpoints, parâmetros, schemas e exemplos, pronto para ser adicionado ao README.

2. Renderizar comentários anotados como HTML interativo

Engenheiro de Software

Contexto: Um projeto interno pequeno não possui uma especificação OpenAPI formal, apenas comentários no código.
Problema: Criar uma página web rápida e legível para a equipe de front-end consultar os endpoints de faturamento.
Como usar: Insira os comentários anotados (ex: @route POST /invoices), selecione 'HTML interativo' como saída e escolha o tema 'Papel'.
Configuração de exemplo: Formato de origem: Comentários anotados | Formato de saída: HTML interativo | Tema: Papel | Incluir exemplos: Não
Resultado: Uma página HTML limpa e interativa detalhando o endpoint de faturamento, sem a necessidade de escrever um arquivo OpenAPI complexo.

Testar com amostras

html, markdown, pdf

Exemplos PDF

Exemplos PDF gerados por ferramentas de 2026-02-01 a 2026-02-10

matched family markdown,pdf,text

markdown, pdf

Exemplos de Apresentacoes Markdown

Decks Markdown estilo Remark/Marp para testar exportacao em PDF

matched family markdown,pdf,text

markdown, pdf

Exemplos OpenAI API

Exemplos abrangentes da API OpenAI incluindo modelos GPT, geração de imagens DALL-E, processamento de áudio Whisper e chamadas de função

title token api

text

API Gráfica WebGPU

API gráfica moderna para gráficos 3D de alta performance e computação GPU no navegador

title token api

text

Hubs relacionados

Ferramentas OpenAPI para documentação, geração de código e revisão de contrato

Compare geração de código OpenAPI, documentação de API, diff de schemas, validação de respostas e testes de contrato em um único hub para design e manutenção de APIs.

Ferramentas de teste de contrato de API, mocking e revisão de schemas

Gere tipos e documentação a partir de OpenAPI, crie mocks, valide respostas reais e revise mudanças críticas de schema em um único hub.

Ferramentas de conversão de caixa, codificação e normalização de texto

Compare conversão de caixa de texto, conversão de largura de caracteres, conversão de codificação, tratamento de quoted-printable e normalização de texto em um único hub.

Ferramentas de conversao PDF e exportacao documental

Compare ferramentas que convertem documentos, imagens e extracoes estruturadas para ou a partir de PDF em um unico hub.

FAQ

Quais formatos de entrada são suportados?

A ferramenta suporta especificações OpenAPI em JSON ou YAML, além de comentários anotados estruturados. A detecção automática facilita o processo.

Posso exportar a documentação em PDF?

Sim, você pode escolher entre HTML interativo, Markdown e PDF como formato de saída.

É possível ocultar os exemplos de resposta da documentação?

Sim, basta desmarcar a opção 'Incluir exemplos' antes de gerar o documento.

O que são os temas disponíveis?

Oferecemos os temas 'Lousa' (Slate) e 'Papel' (Paper) para personalizar a aparência da sua documentação HTML ou PDF.

Preciso ter um arquivo OpenAPI completo para usar a ferramenta?

Não, você também pode usar blocos de comentários anotados simples (como @route, @summary, @response) para gerar a documentação.

Documentação da API

Ponto final da solicitação

POST /pt/api/tools/api-doc-generator

Parâmetros da solicitação

Nome do parâmetro	Tipo	Requerido	Descrição
sourceText	textarea	Sim	-
sourceFormat	select	Não	-
outputFormat	select	Não	-
documentTitle	text	Não	-
theme	select	Não	-
includeExamples	checkbox	Não	-
includeSchemas	checkbox	Não	-

Formato de resposta

{
  "filePath": "/public/processing/randomid.ext",
  "fileName": "output.ext",
  "contentType": "application/octet-stream",
  "size": 1024,
  "metadata": {
    "key": "value"
  },
  "error": "Error message (optional)",
  "message": "Notification message (optional)"
}

Arquivo: Arquivo

Documentação de MCP

Adicione este ferramenta à sua configuração de servidor MCP:

{
  "mcpServers": {
    "elysiatools-api-doc-generator": {
      "name": "api-doc-generator",
      "description": "Gera documentacao API elegante a partir de OpenAPI ou comentarios anotados",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=api-doc-generator",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

Você pode encadear várias ferramentas, ex: `https://elysiatools.com/mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp`, máx 20 ferramentas.

Se você encontrar algum problema, por favor, entre em contato conosco em [email protected]