Saltar al contenido

IBM API Connect – Definir documentación de un API con Open API

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.

  1. Descarga de definición de API Abierta en IBM Developer Portal
    1. Ingresar a la URL de documentación del API indicada. Ej. https://dominio.uat/xyz/uat/node/123
    2. Dirigirse al enlace indicado como API abierta
    3. Se descargará un archivo *.yaml en cuál contendrá una definición abierta del API a consumir
  2. Carga de definición en Swagger Editor
    1. Ingresar a http://editor.swagger.io/, o descargar los binarios para ejecutarlo de forma local
    2. En Swagger Editor dirigirse al menú File/Import File y hacer clic
    3. Aparecerá la siguiente ventana, donde se hará clic en Seleccionar archivo
    4. Seleccionar el archivo *.yaml recién descargado del IBM Developer Portal y hacer clic en Abrir
    5. Se mostrará la siguiente pantalla, validar que el archivo se encuentre señalado y hacer clic en Open file
    6. Se cargará la definición en el Swagger Editor

 

Si te ha interesado este artículo y deseas un apoyo o asesoría en algún requerimiento, envíame un mensaje a: (info@juliopari.com) o sino a través de Linkedin: https://www.linkedin.com/in/juliopari/