Introdução API Interativa

Como funciona API interativa ?

A API interativa exibe a documentação de todos os endpoints, parâmetros e mensagens de erro disponíveis na API EKOS. Para uma explicação mais detalhada da estrutura da API, leia a documentação completa . Se você tiver uma chave de API, também poderá testar chamadas de API diretamente desse painel.

Modelamos a API interativa pensando nos dados, nos recursos, URI's, métodos, parâmetros e respostas. Começamos a definição do serviço criando primeiro a API de comunicação, para só posteriormente pensar na implementação.

Esta abordagem gera um desacoplamento entre implementação e interface de uso, além de permitir que tando o lado cliente quanto o lado servidor possam iniciar seu desenvolvimento assim que a API estiver definida, mesmo sem uma implementação finalizada.

Swagger

O Swagger é um projeto composto por algumas ferramentas que auxiliam o desenvolvedor de APIs REST em algumas tarefas como:

• Modelagem da API
• Geração de documentação (legível) da API
• Geração de códigos do Cliente e do Servidor, com suporte a várias linguagens de programação Para isso, o Swagger especifica a OpenAPI, uma linguagem para descrição de contratos de APIs REST.

Consultas Swagger

Você pode fazer consultas swagger nas APIs facilmente, basta gerar seu token aqui e inserir no authorize do projeto que deseja consultar.