Páginas filhas
  • Validador Automatizado de APIs: Validações realizadas e formas de correção

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

should start with uppercase letter

Todos os nomes dos arquivos de especificações de API devem iniciar com letra maiúscula. Para corrigir este erro, ajuste o nome do arquivo OpenAPI, deixando-o com a primeira letra em uppercase.

...

Todos os schemas referenciados no arquivo Open API devem conseguir ser derreferenciados. O algoritmo de derreferenciação acessa cada uma das referências à schemas e injeta todo o conteúdo do jsonSchema externo no objeto parseado do OpenAPI. Logo, um schema que não pôde ser derreferenciado é um schema que não conseguiu ser acessado da forma correta. Qualquer erro de estruturação do arquivo jsonSchema pode causar uma falha no processo de parsing do arquivo (processo de transformação do arquivo json em objeto).

should contain the same Id property name in URL and body

...

should start with uppercase letter

Todos os nomes dos arquivos de schema devem iniciar com letra maiúscula. Para corrigir este erro, ajuste o nome do arquivo OpenAPI, deixando-o com a primeira letra em uppercase.

should contain version separtor (_)

O nome do arquivo de schema deve conter um "_", que servirá para separar o nome do schema de sua versão (ex. AccommodationType_1_000.json).

shouldn't contain v (_v)

Por convenção, o nome do arquivo jsonSchema não deve conter a letra "v" para evidenciar a versão do schema. Para corrigir este erro, ajuste o nome do arquivo, retirando a letra "v" e deixando apenas os numerais referentes a versão (ex. JobScheduler_1_000.json).

Schemas:

should reference valid objects

Todos os schemas referenciados no arquivo Open API devem conseguir ser parseados da forma correta (significando ser um objeto válido). Qualquer erro de estruturação do arquivo jsonSchema pode causar uma falha no processo de parsing do arquivo (processo de transformação do arquivo json em objeto).

xtotvs:

should be an object in 'info' and may have a 'productInformation'

...

property as an array

A propriedade "x-totvs" dentro da "info" do schema deve ser um objeto e deve, obrigatoriamente, possuir uma propriedade "productInformation" sendo um array.

should have available as a boolean type inside x-totvs

...