El Explorador de APIs es la pantalla principal que aparece una vez se accede a la aplicación y es la que pertenece al icono home.
En esta pantalla se puede visualizar un listado de todas las APIs que se tienen importadas en la organización en la que se encuentra, independientemente de la colección a la que pertenezcan.
En el listado se puede utilizar el buscador y los filtros para buscar con más facilidad una de las apis.
Además, en cada una de las apis existen unos iconos con los que se puede acceder al detalle de la api, se puede actualizar la api o eliminarla.
Importar una API #
Para poder importar una api se debe hacer clic en el botón Importar API que aparece arriba a la derecha.
Una vez se haga clic en el botón se debe abrir un formulario el cual tiene los siguientes campos:
- Nombre de la API a importar
- Colección donde guardar la API: Si no se selecciona una cogerá la que hayamos definido por defecto).
- Etiquetas : Podremos crear nuestras etiquetas, colocando un nombre y luego haciendo clic en Crear.
- Método de importación el cual puede ser:
- Mediante un archivo local donde aparecerá un botón para seleccionar un archivo. (.json, .yaml, .iml, .yml)
- URL donde, habrá que rellenar un campo con la url deseada (en formato raw, tiene que ser una URL pública)
- Mediante repositorio de gitlab, github, bitbucker o azure. Los repositorios solo estarán disponibles si hemos vinculado una cuenta desde “Configuración”.
- Mediante guía de estilos corporativos. Solo estará disponible si anteriormente se ha importado algún api template.
- Mediante estándar de definición donde se puede elegir entre Open telco y Open Banking y dentro de este se debe elegir entre Open Data API – ATM Locator, Read/Write API – Account and Transaction o Open Data API – Branch Locator.
Una vez introducidos los datos pulsando el botón Importar Api se guarda la configuración. Si todo ha salido correctamente se debe visualizar un mensaje de éxito. Si da error se debe visualizar un mensaje de error indicando claramente dicho error.
Información de la API #
En la pantalla “Explorador de APIs”, cada una de las APIs de la tabla tiene el icono de un ojo. Haciendo clic en este icono se puede acceder a la información de la API.
Una vez se accede a esta pantalla se pueden observar dos apartados:
En primer lugar, aparece “Ciclo API First” donde, como su nombre indica se puede hacer un seguimiento del ciclo API first. En segundo lugar, se encuentra el apartado “Información general”.
En este apartado aparece un desplegable para elegir la rama donde aparecen las opciones development y main.
