Documentation

La pestaña DOCUMENTATION le permite registrar la documentación de la API (Swagger) que expone el microservicio correspondiente. Si la documentación ya ha sido registrada, podrá verla o eliminarla.

Para acceder a la pestaña, seleccione un servicio en el listado de la pantalla Services (o después de hacer clic en una malla en la pantalla Meshes).

documentation tab
La pestaña "Documentation"

  • Para poder ver un archivo de documentación registrado para un servicio, su usuario debe tener al menos el permiso Read Documentations activado en Sensedia Access Control.

  • Para registrar o eliminar un archivo de documentación, su usuario debe tener el permiso Write Documentations.

Registro de nueva documentación

Si aún no hay documentación registrada para el servicio seleccionado, la pestaña DOCUMENTATION de este servicio contendrá el campo Select file…​, que permite cargar un archivo Swagger.

Para registrar una documentación para este servicio, haga clic en el icono icon upload. Se abrirá una ventana para elegir el archivo Swagger a cargar. Una vez seleccionado el archivo deseado, haga clic en el botón UPDATE para cargarlo. A continuación, el archivo seleccionado se cargará y se mostrará en la pestaña.

Los formatos de archivo Swagger compatibles son YAML y JSON.

Gestión de la documentación registrada

Si el servicio seleccionado ya tiene documentación registrada, esta se mostrará en la pestaña DOCUMENTATION.

documentation view
Visualización de la documentación registrada para un servicio

En la esquina superior derecha del contenido de la pestaña, se encuentran los siguientes botones:

  • icon view: Cuando se hace clic, se abre la documentación en una nueva pestaña del navegador;

  • icon delete: Permite eliminar la documentación registrada.

Thanks for your feedback!
EDIT

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