Categorias

← View All Tools

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 }

Fatos principais

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

Visão geral

API Doc Generator transforma especificacoes OpenAPI ou comentarios estruturados em documentacao API clara, organizada e pronta para compartilhamento.

Quando usar

  • •Quando voce precisa gerar HTML, Markdown e PDF a partir da mesma fonte.
  • •Quando a equipe quer reunir endpoints, parametros, respostas e erros em uma referencia unica.
  • •Quando ja existe Swagger/OpenAPI, mas a apresentacao ainda nao esta ideal.
  • •Quando comentarios anotados sao a principal fonte de documentacao.

Como funciona

  • •Cole OpenAPI JSON, YAML ou comentarios estruturados.
  • •A ferramenta extrai endpoints, parametros, corpo de requisicao, respostas e erros.
  • •Depois organiza tudo em uma referencia API bem formatada.
  • •Voce pode manter exemplos e schemas para uso tecnico.

Casos de uso

Publicar referencia interna para equipes backend.
Compartilhar documentacao com parceiros de integracao.
Gerar um PDF para auditoria, entrega ou onboarding.
Salvar uma versao Markdown diretamente no repositorio.

Exemplos

1. Gerar documentacao para parceiros a partir de um spec existente

Desenvolvedor backend
Contexto
A equipe ja mantem uma especificacao OpenAPI para um servico de pagamentos.
Problema
Ela precisa de uma versao mais apresentavel para parceiros externos.
Como usar
Cole o spec, mantenha os exemplos ativados e exporte como HTML ou PDF.
Configuração de exemplo
Formato da fonte: Auto Detect. Saida: HTML interativo ou PDF.
Resultado
A equipe obtém uma referencia clara com endpoints, parametros, schemas e respostas.

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
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
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

Hubs relacionados

Ferramentas de Html para Convert
Explore 11 ferramentas de html para fluxos de convert e encontre utilitários próximos com rapidez.
Ferramentas de Text para Convert
Explore 80 ferramentas de text para fluxos de convert e encontre utilitários próximos com rapidez.
Ferramentas de Pdf para Convert
Explore 28 ferramentas de pdf para fluxos de convert e encontre utilitários próximos com rapidez.
Ferramentas de Markdown para Convert
Explore 15 ferramentas de markdown para fluxos de convert e encontre utilitários próximos com rapidez.

FAQ

A ferramenta aceita Swagger ou OpenAPI?

Sim. Ela processa entradas JSON e YAML no formato OpenAPI ou Swagger.

Ela inclui exemplos de resposta e codigos de erro?

Sim. Quando essas informacoes existem na fonte, elas podem ser mostradas na documentacao.

Posso exportar em formatos diferentes?

Sim. A mesma fonte pode virar HTML interativo, Markdown ou PDF.

Serve mesmo sem um spec completo?

Sim. Comentarios estruturados ajudam a documentar APIs ainda em formacao.

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]