Leia-me

Importante:

Planejamos atualizar a versão do Orchestrator Swagger para o Swagger 3.0. Atualmente, as APIs do Orchestrator são definidas usando o Swagger 2.0.

Não se preocupe com a compatibilidade com versões anteriores de seus clientes de API existentes: garantiremos que a API permaneça compatível.

Recomendamos o uso de seus clientes anteriores, pois as alterações JSON não os alteram, graças à compatibilidade com versões anteriores de nossa estrutura de solicitação.

Após a atualização para o Swagger 3.0, todos os clientes de API regenerados com base na nova definição JSON terão que ser reajustados.

Se você planeja integrar nossas APIs com seu cliente, precisa estar ciente das possíveis atualizações e alterações que podem ocorrer na definição do Swagger, esquemas JSON ou terminais de API.

A lista abaixo fornece informações e recomendações sobre as alterações do Swagger. Se você tiver mais perguntas, entre em contato com nossa equipe de suporte.

Informações e recomendações sobre mudanças no Swagger

1. A descrição da API JSON representada no documento Swagger JSON pode mudar a qualquer momento. No entanto, ele descreverá a mesma API subjacente, para garantir a compatibilidade com versões anteriores.
2. A interface Swagger e o JSON correspondente são gerados com base nos endpoints atuais e sempre publicamos a versão mais recente. Para garantir a compatibilidade com versões anteriores, oferecemos suporte à mesma estrutura de solicitação.
3. Como alternativa aos clientes API gerados em tempo de execução, use clientes API fixos ou em tempo de compilação. Isso reduz a dependência e evita grandes atualizações de automação caso a API ou a definição do Swagger sejam alteradas.
4. Os itens marcados como obsoletos estão disponíveis por um tempo limitado, após o qual os itens são removidos da definição do Swagger e da API JSON.
5. Sempre que certas APIs mudam internamente, uma nova versão da Swagger API é publicada. O número da versão da API não influencia o uso da API do cliente. Não recomendamos depender do controle de versão da API.

Exemplos de API

Os exemplos fornecidos no documento de referência existente do Orchestrator descrevem cenários e endpoints complexos.

Você pode ver todas as APIs disponíveis no Swagger JSON, que contém as atualizações mais recentes.