Documentation

🕓 10 minutes

What you’ll learn#

How to generate swagger documentation and a diagram for your application component to see its structured description for better storing and analyzing the code.

Prerequisites#

Steps#

  1. First of all, go to "Documentation" and select the "Dashboard" section.
    • Here you will see all the available applications with application components.
    • For each of them you can generate a diagram with Draw.io and API documentation with Swagger.io.
preview

  1. Click on the "Setup Documentation" button and after a short time, there will appear two buttons: "Diagrams" and "API Landscape".
setup_doc

buttons

  1. For generating a diagram, simply click on the "Diagrams" button.
  • It will redirect you to the Draw.io page, where you will need to authorize with the gitlab login and password.
  • After that, you will be free to create a diagram for your component.
  • For commiting changes to the gitlab, click on the "Save" option in the "File" menu.

diagram

  1. For generating an API documentation with Swagger.io, click on the "API Landscape" button.
api_button

  • Here you see the generated Swagger file and its UI representation.
    • You can change some properties in the .yaml file. All your changes will be automatically visible in the UI representation on the right.
    • For more information about the Swagger documentation, see: https://swagger.io/docs/specification/about/
swagger_preview

  • To save your changes to Git, simply click on the "Save to Git" button.
    • It will generate a new repository with the name "application-name-documentation".
      • This repository contains a draw.io diagram and swagger documentation of the component.
git_button

What`s next?#

See our other manuals: