🕓 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.



  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 and API documentation with

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


  1. For generating a diagram, simply click on the "Diagrams" button.
  • It will redirect you to the 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.


  1. For generating an API documentation with, click on the "API Landscape" 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:

  • 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 diagram and swagger documentation of the component.

What`s next?#

See our other manuals: