Leia o contrato da sua API

Sua API.
Bem documentada.

Abra um contrato YAML ou JSON e explore endpoints, parâmetros, respostas e schemas com Swagger UI.

Seus dados não saem deste navegador
Visualizador SwaggerLeia · Explore · Entenda
Código do contrato da API
YAML / JSON0 caracteres

YAML ou JSON · Até 2 MB

Pronto para ler um contrato

Documentação da API

Visualizador de leitura. Seu contrato permanece neste navegador.

O Swagger UI usa rótulos em inglês. O texto do contrato é exibido no idioma original.

Carregue um contrato para visualizar a documentação

06 / API

Entenda o contrato.
Antes de programar.

01

Contratos compatíveis

Leia contratos Swagger 2.0 e OpenAPI 3.0 ou 3.1, incluindo referências internas e schemas reutilizáveis.

02

Um arquivo completo

Use um único documento YAML ou JSON. Incorpore as referências externas ao contrato antes de abri-lo.

03

Explore sem enviar requisições

Consulte operações, exemplos e definições de autenticação. Este visualizador não executa chamadas à API nem usa um validador online.