Ir para o conteúdo
Totalmente local

Listar endpoints de OpenAPI

Extraia todos os endpoints de um documento OpenAPI ou Swagger como uma tabela legível.

Entrada
Saída

Listar endpoints de OpenAPI

Cole um documento OpenAPI ou Swagger — JSON ou YAML, OpenAPI 3 ou Swagger 2 — e esta ferramenta extrai todos os endpoints para uma lista legível. É construída para o momento em que recebe um ficheiro de especificação e precisa de uma visão geral rápida antes de mergulhar nos detalhes: que rotas existem, o que precisam e o que retornam.

Filtre a lista por método HTTP ou por tag para se concentrar numa parte da API. Alterne parâmetros de caminho e consulta, o tipo de conteúdo do corpo do pedido, códigos de resposta e se um endpoint requer autenticação — a ferramenta lê requisitos de segurança por operação, recuando para a segurança global do documento quando uma operação não a sobrescreve. Ative "Saltar endpoints descontinuados" para ocultar rotas marcadas como descontinuadas na especificação e incluir o campo de resumo de cada endpoint para contexto adicional sem abrir o ficheiro de origem.

Ordenar o resultado por caminho ou por tag, e escolha um formato de saída que corresponda ao que precisa a seguir: uma lista simples para uma leitura rápida, uma tabela Markdown para colar em documentação ou um pull request, ou CSV para abrir numa folha de cálculo. Os parâmetros que são definidos com $ref em vez de inline são ignorados em vez de adivinhados, porque resolver uma referência corretamente precisa do resto do documento.

Tudo funciona localmente no seu navegador — a especificação da API nunca sai do seu dispositivo, o que é importante quando descreve um serviço interno ou não lançado. Copie o resultado, descarregue-o como ficheiro .txt ou envie-o diretamente para outra ferramenta para continuar a trabalhar.

FAQ

Suporta tanto OpenAPI 3 como Swagger 2?
Sim. Ambos os formatos mantêm endpoints numa secção "paths" com a mesma forma, portanto o mesmo leitor processa qualquer versão.
Como decide se um endpoint necessita de autenticação?
Verifica primeiro o campo "security" da operação. Uma matriz vazia aí significa que esse endpoint desativa explicitamente a autenticação; se o campo estiver em falta, a ferramenta recua para a definição "security" global do documento.
Consegue resolver referências $ref?
Não para parâmetros — um parâmetro definido com $ref não tem um nome inline, portanto é ignorado em vez de ser resolvido, porque isso exigiria ler o resto do documento.
O que acontece com um documento inválido ou não relacionado?
Verá uma mensagem clara: uma para texto que não é JSON ou YAML válido, e outra quando o documento é analisado bem mas não tem uma secção "paths".
A minha especificação de API é carregada em qualquer lugar?
Não. A análise e formatação acontecem inteiramente no seu navegador — o documento que cola nunca sai do seu dispositivo.