Páginas filhas
  • DEAITOOLS-203 Ferramenta para validar se houve breackchanges

Versões comparadas

Chave

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

...

Avaliada uma ferramenta Open source, e esta foi utilizada, apenas modificada para gerar um JSON e criado endpoints que serão consumidos pelo validador.

Estão disponíveis 2 endpoint um para retorno em plain/text e um para retorno em JSON, tanto no verbo POST quanto GET, para o funcionamento deve-se mandar um body na requisição com as seguintes propriedades:

olderVersion: versão anterior que será verificada;

newerVersion: versão mais nova que será verificada;

ambas propriedade devem conter o OpenApi dereferenciado e em formato de uma string;


Bloco de código
languagejs
titleExemplo de requisição
{
	"olderVersion": "{\"openapi\":\"3.0.1\",\"servers\":[{\"description\":\"API para realizar o gerenciamento de vendedores nos produtos TOTVS\",\"url\":\"http://{serverUrl}:{serverHttpPort}/api/crm/v1\",\"variables\":{\"serverUrl\":{\"default\":\"localhost\"},\"serverHttpPort\":{\"default\":\"8090\"}}}],\"info\":{\"description\":\"API para realizar o g... erro.\"},\"helpUrl\":{\"type\":\"string\",\"format\":\"uri\",\"description\":\"URI para documentação do erro.\"}}}}}}]}}}}}}}},\"components\":{\"parameters\":{\"InternalId\":{\"name\":\"InternalId\",\"in\":\"path\",\"required\":true,\"description\":\"Identificador único representando a entidade\",\"schema\":{\"type\":\"string\"}}}}}",
	"newerVersion": "{\"openapi\":\"3.0.1\",\"servers\":[{\"description\":\"API para realizar o gerenciamento de vendedores nos sdfsdprodutos TOTVS\",\"url\":\"http://{serverUrl}:{serverHttpPort}/asafsa/crm/v1\",\"variables\":{\"serverUrl\":{\"default\":\"localhost\"},\"serverHttpPort\":{\"default\":\"8090\"}}}],\"info\":{\"description\":\"API para realizar o gerenciamento de vendedores nos produtos TOTVS\"... erro.\"}}}}}}]}}}}}}}},\"components\":{\"parameters\":{\"InternalId\":{\"name\":\"InternalId\",\"in\":\"path\",\"required\":true,\"description\":\"Identificador único representando a entidade\",\"schema\":{\"type\":\"string\"}}}}}"
}



Templatedocumentos


HTML
<style>
div.theme-default .ia-splitter #main {
    margin-left: 0px;
}
.ia-fixed-sidebar, .ia-splitter-left {
    display: none;
}
#main {
    padding-left: 10px;
    padding-right: 10px;
    overflow-x: hidden;
}

.aui-header-primary .aui-nav,  .aui-page-panel {
    margin-left: 0px !important;
}
.aui-header-primary .aui-nav {
    margin-left: 0px !important;
}
</style>