El presente artículo busca estandarizar la lectura de la documentación de una API publicada en el IBM Developer Portal a través de Swagger Editor, con el fin de facilitar al App Developer el uso de las API’s desarrolladas por el API Developer.
- Descarga de definición de API Abierta en IBM Developer Portal
- Ingresar a la URL de documentación del API indicada. Ej. https://dominio.uat/xyz/uat/node/123
- Dirigirse al enlace indicado como API abierta
- Se descargará un archivo *.yaml en cuál contendrá una definición abierta del API a consumir
- Carga de definición en Swagger Editor
- Ingresar a http://editor.swagger.io/, o descargar los binarios para ejecutarlo de forma local
- En Swagger Editor dirigirse al menú File/Import File y hacer clic
- Aparecerá la siguiente ventana, donde se hará clic en Seleccionar archivo
- Seleccionar el archivo *.yaml recién descargado del IBM Developer Portal y hacer clic en Abrir
- Se mostrará la siguiente pantalla, validar que el archivo se encuentre señalado y hacer clic en Open file
- Se cargará la definición en el Swagger Editor