Inserir, Alterar e Excluir um Swagger no Portal do Desenvolvedor

 

Há duas formas de Inserir, Alterar e Excluir Swagger no Portal do Desenvolvedor. A primeira forma é através do Manager (Sensedia API Platform) e a segunda é diretamente pelo portal, realizando um import.

 

Inserindo um Swagger através do Manager (Sensedia API Platform):

 

No menu API, escolha qual a API deseja vincular ao Portal do Desenvolvedor.

Nas opções da API,  utilize o botão "Show iterative documentation (Swagger)”

Após ativá-lo, um novo botão surgirá para selecionar em qual “Environment” será realizado o “Try It Out”

Na próxima tela escolha o “Environment” e então clique em “Save”



Confirme se o “Environment” selecionado está certo e em seguida salve as alterações na API.

Pronto, o Swagger já estará disponível no Portal do Desenvolvedor.

 

Alterando um Swagger através do Manager (Sensedia API Platform):

 

Qualquer alteração/atualização realizada na API através do Manager (Sensedia API Platform) é refletido instantâneamente no Swagger do Portal do Desenvolver, sem que haja a necessidade de interações.

 

Excluindo um Swagger através do Manager (Sensedia API Platform):

Para remover o Swagger do Portal do Desenvolvedor, utilize o botão "Show iterative documentation (Swagger)" nas opções da API (o mesmo utilizado para inserir).

 

Inserindo um Swagger através do Portal do Desenvolvedor

Para inserir (importar) um Swagger diretamente no Portal do Desenvolvedor, acesse o seguinte Menu:

Configurações > Sensedia > Swagger 3

Na tela do Swagger 3, escolha a API que o Swagger será vinculado, o tipo de Role e clique em “+ Add files” e selecione o arquivo .json que será importado.

Após selecionar o arquivo, confirme se o mesmo está correto na caixa de “upload” e clique em “Start upload”

Realizado o upload, clique em submeter.

 

Alterando um Swagger através do Portal do Desenvolvedor

Realizar os mesmos procedimentos utilizados para incluir um Swagger, substituindo apenas o arquivo que será enviado na caixa de “upload”.

 

Removendo um Swagger através do Portal do Desenvolvedor

Realizar os mesmos procedimentos utilizados para incluir um Swagger, deixando sem arquivo a caixa de “upload” e clique em “Submeter”, como segue:


Tem mais dúvidas? Envie uma solicitação

Comentários

Powered by Zendesk