Swagger

Consejo

Swagger es un framework 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 soporte para documentación automatizada, generación de código y generación de casos de prueba.

Cómo acceder a Swagger

Nota

En el ejemplo siguiente utilizamos la URL localhost de OpenKM. Usted debe utilizar su propia URL de OpenKM (la IP o el dominio asociados).

Para acceder a la documentación de Swagger, abra en su navegador la URL http://localhost:8080/OpenKM/services/ y obtendrá una página como la de la imagen siguiente:

Haga clic en la URL http://localhost:8080/OpenKM/services/rest/api-docs?url=/OpenKM/services/rest/swagger.json y se mostrará una pantalla como la siguiente, que solicita las credenciales de un usuario autorizado:

Después se mostrará la herramienta Swagger:

Probar Swagger

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

• Abra Auth-Service

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

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

• Finalmente se mostrarán los resultados