¶ 1. Visão Geral.
O Swagger é uma ferramenta que facilita a criação, documentação e consumo de APIs (Application Programming Interface). Ele fornece uma interface interativa que permite aos desenvolvedores e consumidores externos, visualizar, testar e interagir com as endpoints de uma API de maneira intuitiva. Através do Swagger, é possível gerar automaticamente a documentação da API a partir do código-fonte, garantindo que a documentação esteja sempre atualizada e em sincronia com as implementações. Além disso, o Swagger suporta uma ampla gama de linguagens de programação e frameworks.
¶ 2. Autenticação e autorização.
Temos algumas formas de autenticação dentro do Swagger, as normalmente utilizadas são:
- Basic: Autorização utilizando usuário e senha, separados por ":" convertidos em Base64;
- Bearer: É um Schema que utiliza um Token do tipo JWP (Jason Web Token) que autoriza o usuário a acessar as APIs;
- OAuth 2: É protocolo de autorização via Token;
Para acessar algumas APIs do T6 é necessário que o usuário esteja autenticado (com login e senha ou outro método)
¶ 3. Utilização.
Para abrir o Swagger, iremos utilizar o endpoint: URL.../swagger/index.html
- Exemplo de endpoint em ambiente cloud:
qablue.tech6cloud.com/swagger/index.html; (neste caso, qablue é o nome do seu domínio.) - Exemplo de endpoint em ambiente local:
(servidor do IIS)/(nome da aplicação no IIS)/swagger/index.html
A URL informada antes da API vai depender do seu domínio na cloud, ou, em caso de ambiente local, das configurações informadas no seu IIS (Internet Information Services).
Ao acessar o endpoint será aberta uma página contendo todas as APIs do sistema, clique em 
para expandir a API selecionada.
- Serão exibidos os parâmetros necessários para a execução da API e também as possíveis respostas que o sistema pode lhe retornar, assim como uma exibição detalhada da requisição, para habilitar a inserção dos parâmetros e executar a API, clique em "Try it out";
- Ao clicar em "Try it out" será habilitada a inserção de dados nos parâmetros, além da exibição do botão "Execute", que fará a execução da API conforme os parâmetros inseridos;
- Ao executar a API, o Swagger irá devolver uma resposta com o código e a descrição, informando quanto ao sucesso ou falha na execução, em caso de falha, irá devolver detalhadamente o código de erro e o motivo da falha.
Para mais informações e formas de consumir as APIs, acesse nossa central de ajuda: Data Integration