Tecnología #rest#web#docker 1 min

Documentación y cliente web de la API Swagger

Traducción del original en inglés. Léela en: CatalàEnglish

Por ejemplo, usamos NPM (Nginx Proxy Manager). La interfaz web de usuario (WUI) de NPM se apoya en una API de backend. Si inspeccionas las peticiones de red de tu navegador, puedes observar cómo funciona.

Sin embargo, no fui capaz de encontrar documentación completa de esta API. Con un poco de investigación, puedes descubrir que la API de NPM expone su esquema en una ubicación concreta:

https://npm.your-domain.tld/api/schema

Si buscas un cliente de API cómodo basado en web, junto con una interfaz documentada que te ayude a entender cómo usarlo, simplemente ejecuta el siguiente contenedor Docker:

docker run -p 80:8080 -d swaggerapi/swagger-ui

Abre tu navegador y ve a http://localhost, y verás algo como esto:

Finalmente, sustituye la URL de la API Petstore por la tuya, como por ejemplo https://npm.your-domain.tld/api/schema, o por cualquier URL de OpenAPI que quieras utilizar.

A continuación tienes una captura de pantalla de mi configuración local de NPM:

Espero que esta entrada te haya resultado útil. Gracias por tomarte el tiempo de leerla.