ToolRobinSem login, use na hora

Verificador de compatibilidade OpenAPI

Compare duas especificações do OpenAPI 3.x localmente e revise possíveis alterações no contrato da API por operação e caminho de campo.

Cole ou escolha os arquivos OpenAPI 3.0, 3.1 ou 3.2 originais e revisados. Verifique a gravidade e o caminho do campo afetado e baixe um relatório Markdown ou JSON para revisão.

Compare dois arquivos OpenAPI antes do lançamento. As especificações ficam neste navegador.

Cole JSON ou YAML abaixo ou escolha um arquivo.
Cole JSON ou YAML abaixo ou escolha um arquivo.

Cada arquivo: até 2 MB e 1.000 operações. Suporta OpenAPI 3.0, 3.1 e 3.2.

Como usar

Revise as alterações do OpenAPI antes de lançar uma API

Compare duas especificações do OpenAPI 3.x localmente e revise possíveis alterações no contrato da API por operação e caminho de campo.

Passo a passo

  1. Forneça a origem usando: Especificação original / Especificação revisada.
  2. Execute: Verifique a compatibilidade. Confira o resultado antes de copiar, baixar ou usar em outro lugar.
  3. Cole ou escolha os arquivos OpenAPI 3.0, 3.1 ou 3.2 originais e revisados. Verifique a gravidade e o caminho do campo afetado e baixe um relatório Markdown ou JSON para revisão.

Como escolher as configurações

OpçãoO que muda
Especificação originalAs referências dentro de um arquivo de especificação são seguidas. Referências externas de arquivo ou URL não são buscadas e aparecem como resultados de revisão. Esquemas recursivos são comparados em sua primeira ocorrência e marcados para revisão.
Verifique a compatibilidadeO verificador compara operações, parâmetros, corpos de solicitação, códigos de resposta e tipos de mídia, além de alterações comuns de esquema, como propriedades removidas, propriedades de solicitação recentemente exigidas, alterações de tipo e valores de enum. As descobertas incluem a operação afetada e o caminho do campo.

Exemplo e resultado esperado

Se a resposta GET /users/{id} revisada tornar obrigatório um campo `email` opcional, o relatório sinalizará o contrato de resposta alterado. As referências locais `$ref` são seguidas; referências externas e composição de esquema complexo são solicitadas para revisão manual. Este não é um validador de especificações completo ou um teste da API em execução.

Se não funcionar

  • O resultado é uma revisão estática do contrato, não um validador completo de conformidade OpenAPI, teste de API em tempo de execução ou auditoria de segurança. O comportamento do servidor, a lógica de autorização e a composição complexa do esquema podem exigir revisão manual. O relatório diz quais referências ou estruturas recursivas não foram totalmente verificadas.
  • Se a análise falhar, confira a sintaxe JSON ou YAML antes dos resultados da API. Inclua as referências locais necessárias no mesmo documento. Referências externas e estruturas não aceitas exigem revisão manual; a ferramenta não as busca nem testa um servidor real.

Quais alterações são verificadas?

O verificador compara operações, parâmetros, corpos de solicitação, códigos de resposta e tipos de mídia, além de alterações comuns de esquema, como propriedades removidas, propriedades de solicitação recentemente exigidas, alterações de tipo e valores de enum. As descobertas incluem a operação afetada e o caminho do campo.

Como as referências são tratadas?

As referências dentro de um arquivo de especificação são seguidas. Referências externas de arquivo ou URL não são buscadas e aparecem como resultados de revisão. Esquemas recursivos são comparados em sua primeira ocorrência e marcados para revisão.

O que está fora desta verificação?

O resultado é uma revisão estática do contrato, não um validador completo de conformidade OpenAPI, teste de API em tempo de execução ou auditoria de segurança. O comportamento do servidor, a lógica de autorização e a composição complexa do esquema podem exigir revisão manual. O relatório diz quais referências ou estruturas recursivas não foram totalmente verificadas.

Você também pode precisar