Swagger

Consejo

Swagger es un marco de software de código abierto, respaldado por un amplio ecosistema de herramientas, que ayuda a los desarrolladores a diseñar, construir, documentar y consumir servicios web RESTful. Aunque la mayoría de los usuarios identifican Swagger con la herramienta Swagger UI, el conjunto de herramientas de Swagger incluye compatibilidad con la generación automática de documentación, de código y de casos de prueba.

Cómo acceder a Swagger

Nota

En el ejemplo siguiente utilizamos la URL de nuestra demo de OpenKM. Usted debe utilizar la URL de su OpenKM.

Para acceder a la documentación de Swagger, haga clic en la URL http://localhost:8080/openkm/swagger-ui.html; aparecerá una pantalla como la que se muestra a continuación, que solicita las credenciales de un usuario autorizado:

A continuación se mostrará la herramienta Swagger:

Probando Swagger

Hagamos una prueba rápida de la herramienta comprobando el método getRoles de auth-service.

• Abra auth-service

• Abra el método “roles” y haga clic en el botón “Try it out”:

• Haga clic en el botón “Execute”.

• Por último, se mostrarán los resultados