API Docs
API Docs gerencia as documentações técnicas das suas APIs, que estarão disponíveis em Products.
A documentação é carregada automaticamente no momento da importação da API, mas você também pode adicioná-la manualmente.
Também é possível editar e excluir (quando a documentação tiver sido adicionada manualmente) e visualizar.
Lista de API Docs
A lista de API Docs exibe:
-
Type: a documentação pode ser do tipo Swagger 3.0 ou OpenAPI 3.0;
-
API Name: nome da API, tal como cadastrada na plataforma;
-
Version: versão da API;
-
Last revision: última revisão da API;
-
Source: origem da documentação (API Plataform ou upload manual);
-
Actions: a partir desta coluna, você pode editar, deletar e visualizar uma documentação, clicando no ícone respectivo.
Os ícones de ação para editar (![]() ![]() |
Visualizando uma documentação
Para verificar se a sua documentação está de acordo com a API importada, siga os passos abaixo:
Como resultado desses passos, a documentação será carregada e exibida na tela. Uma vez carregada, a coluna TYPE, da listagem de API Docs, passa a indicar o tipo daquela documentação, sendo:
-
OpenApi e
-
Swagger.