Documentation

A aba DOCUMENTATION permite cadastrar a documentação da API (Swagger) que expõe o microsserviço correspondente. Se já houver documentação cadastrada, será possível visualizá-la ou exclui-la.

Para acessar a aba, selecione um serviço na listagem da tela Services (ou depois de clicar sobre um mesh na tela Meshes).

documentation tab
Aba "Documentation"

  • Para poder visualizar um arquivo de documentação cadastrado para um serviço, é necessário que seu usuário tenha ao menos a permissão Read Documentations ativada no Sensedia Access Control.

  • Para poder cadastrar ou excluir um arquivo de documentação, é necessário que seu usuário possua a permissão Write Documentations.

Cadastrando uma nova documentação

Se ainda não houver documentação cadastrada para o serviço selecionado, a aba DOCUMENTATION desse serviço conterá o campo Select file…​, que possibilita o carregamento de um arquivo Swagger.

Para cadastrar uma documentação para esse serviço, clique no ícone icon upload. Uma janela será aberta para a escolha do arquivo Swagger a ser carregado. Selecionado o arquivo desejado, clique no botão UPDATE para efetuar o carregamento. O arquivo selecionado será então carregado e exibido na aba.

Os formatos de arquivo Swagger suportados são YAML e JSON.

Gerenciando a documentação cadastrada

Se o serviço selecionado já possuir documentação cadastrada, ela será exibida na aba DOCUMENTATION.

documentation view
Visualizando a documentação cadastrada para um serviço

No canto superior direito do conteúdo da aba, há os seguintes botões:

  • icon view: Quando clicado, abre a documentação em uma nova aba do seu navegador;

  • icon delete: Permite excluir a documentação cadastrada.

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]