Swagger

Tip

Swagger is an open-source software framework backed by a large ecosystem of tools that helps developers design, build, document, and consume RESTful Web services. While most users identify Swagger by the Swagger UI tool, the Swagger toolset includes support for automated documentation, code generation, and test case generation.

How to access Swagger

Note

In the sample below, we use our OpenKM demo URL. You should use your OpenKM URL.

To access the Swagger documentation, click the URL http://localhost:8080/openkm/swagger-ui.html; a screen like the one shown below will appear, asking for authorized user credentials:

Then the Swagger tool will be shown:

Playing with Swagger

Let’s do a quick test of the tool by checking the getRoles method from auth-service.

• Open the auth-service

• Open the “roles” method and click the “Try it out” button:

• Click on the “Execute” button.

• Finally, the results will be shown