O ApiCompare é um endpoint REST utilizado para realizar requisições HTTPs, onde fará a comunicação com o OpenAPI-Diff, esse tem a responsabilidade de verificar se houve ou não alteração em um "SChema" ou "API".
O Endpoint utilizado referente ao projeto do ApiCompare "/totvseai/openapicomparator/v1", porém ele está divido em 4 métodos https.
- Método POST path = "/console"
- Método POST path = "/json"
- Método GET path = "/console"
- Método GET path = "/json"
Metódo POST path = "/console": No corpo da requisição será enviado o json com as informações referente ao documento antigo e novo documento e o comparador o "openapi-diff" retorná o documento no formato TEXT/PLAIN informando se as alterações gerou exceções ou se estão corretas.
Metódo POST path = "/json": No corpo da requisição será enviado o json com as informações referente ao documento antigo e novo documento e o comparador o "openapi-diff" retorná o documento no formato APPLICATION/JSON informando se as alterações gerou exceções ou se estão corretas.
Metódo GET path = "/console": No corpo da requisição será enviado o json com as informações referente ao documento antigo e novo documento e o comparador o "openapi-diff" retorná o documento no formato TEXT/PLAIN informando se as alterações gerou exceções ou se estão corretas.
Metódo GET path = "/console": No corpo da requisição será enviado o json com as informações referente ao documento antigo e novo documento e o comparador o "openapi-diff" retorná o documento no formato APPLICATION/JSON informando se as alterações gerou exceções ou se estão corretas.