1. Introducción #
API Quality es una herramienta que permite implementar todo el ciclo de vida de API First de forma exitosa y eficiente.
En este documento se explican los pasos a seguir para el uso correcto de la herramienta. Los principales apartados que abordaremos son los siguientes:
- Registro.
- Inicio de sesión.
- Configuración de la organización.
- Colecciones de APIs.
- Importar APIs a la herramienta.
- Gestión del ciclo API First de una API.
- Reportes por Colecciones.
- Reportes por Organizaciones.
2. Registro #
Para poder hacer uso de la herramienta es necesario estar dados de alta en ella. Para ello accedemos a la URL https://app.apiquality.es/user/signin, donde visualizaremos una pantalla como la siguiente :
Para crear una cuenta debemos pulsar el botón Regístrate gratis, donde se mostrará un formulario que deberemos cumplimentar.
Para poder registrarse, es necesario aceptar las políticas de privacidad y rellenar toda la información requerida.
Una vez enviada y procesada la petición, se recibirá un correo de verificación de cuenta. Es importante recalcar que si no se verifica el correo electrónico no podrá empezar a utilizar APIQuality.
3. Iniciar sesión #
Una vez realizado el registro y verificado el mail, podremos acceder a APIQuality.
Introduciremos el mail con el que nos dimos de alta y la contraseña que registramos.
4. Organización #
Todo dentro de API Quality gira en torno a una entidad denominada “organización”. Es por ello por lo que, dentro de API Quality, encontraremos una serie de parámetros configurables que nos permitirán operar posteriormente sobre nuestras APIs (API Managers, guías de estilos, etc.) dentro de una misma organización.
Una vez te registras se crea automáticamente una organización aunque posteriormente se pueden añadir más organizaciones y otro usuario te puede añadir a la suya.
En el campo que aparece en la cabecera de la web se puede observar en qué organización se encuentra el usuario y haciendo clic en dicho campo, este se despliega. En este desplegable se puede cambiar de organización haciendo clic en otra de las que aparezcan.
También en ese mismo desplegable se puede crear una nueva organización, haciendo clic en “Crear organización”.
Se abrirá un modal, en el cual se nos pedirá introducir un nombre para nuestra organización y crearemos la misma.
5. Configuración #
En la cabecera de web existe el icono “engranaje” y haciendo clic sobre él se despliega un menú con las diferentes pantallas donde se puede acceder.
5.1. General #
Desde configuración se puede acceder a “General” donde aparece el nombre de la organización en la que se encuentra. El nombre de la organización se crea cuando se realiza el registro y desde esta pantalla puede ser editado.
En esta pantalla también se puede elegir si quiere mostrar la URL del repositorio y del Mock Server. Para ello, el checkbox debe de estar seleccionado o no y posteriormente guardar lo seleccionado. Debemos tener en cuenta que de forma predeterminada están activos, los mismos se reflejarán en el apartado 6.2.2.
Por último, nos indica el procedimiento para eliminar una organización, facilitando el correo electrónico de soporte APIQuality (support@apiquality.io).
5.2 Añadir miembros #
Podemos añadir miembros a nuestra organización se hayan registrado o no previamente en API Quality. A estos miembros se les debe añadir un rol o varios y una colección o varias colecciones a las que se sea que tenga acceso los cuales, es imprescindible para poder finalizar el formulario. Con cada uno de los diferentes roles el miembro podrá realizar diferentes acciones..
Al añadir un miembro ya registrado le llegará un correo electrónico informando que ha sido añadido a una organización.
Al añadir un miembro sin registrar, a este le llegará un correo para que realice el registro y posteriormente otro para que verifique la cuenta. En la pantalla de miembros el estado irá cambiando según el miembro se registre y verifique.
Además, los miembros pueden ser editados así como eliminados si es necesario.
5.3 Importar API Template #
En una organización se puede subir uno o varios templete corporativos para que sus desarrolladores puedan acceder a ella a la hora de definir sus APIs y subirlas a la herramienta.
Para ello, se puede acceder a la pantalla “API template” desde el menú de configuración. Al hacer clic “Añadir API template“ se abrirá un formulario y haciendo clic en el botón de Seleccionar fichero se cargará el archivo de definición, siempre que este tenga extensión .yaml, .yml o .json. El cual podremos descargar o eliminar.
5.4 Guía de estilos #
Las guías de estilos son el conjunto de reglas que se aplican al escaneo de las APIs.
Por defecto se crea una guía de estilos con el nombre de la organización que se usa de forma predeterminada en todas las colecciones que creemos y que no tengan vinculada una guía de estilos concreta. Aunque se pueden añadir todas las guías que se deseen a tu organización. Todas las guías de estilos tendrán por defecto activadas todas las reglas.
Para crear más guías de estilos, se debe acceder a dicha pantalla desde el menú de configuración y hacer clic en el botón Crear Guía de Estilos.
Dentro del diálogo de creación, se nos pedirá introducir un nombre para la guía de estilos y marcar si queremos que esta nueva guía sea utilizada por defecto en caso de no vincular ninguna a las colecciones de APIs.
Si todo ha ido bien, visualizamos el siguiente aviso:
Si necesitamos realizar cambios en una guía de estilos, podemos modificarla haciendo clic en el icono del lápiz o eliminarla haciendo clic en el icono de la papelera:
5.4.1. Reglas de una guía de estilos #
Las reglas de las guías de estilos analizan las definiciones de APIs, asegurando que sigan estándares específicos y buenas prácticas, garantizando su correcta funcionalidad y coherencia.
Podemos visualizar las reglas que pertenecen a una guía de estilos concreta haciendo clic en su nombre.
Desde esta pantalla, podemos configurar las reglas que se usarán para escanear una API con la guía de estilos seleccionada, modificar los valores de los parámetros en aquellas reglas que así lo permitan, etc.
Podemos activar y desactivar tantas reglas como queramos, teniendo en cuenta que solo podrán editarse aquellas que se encuentren activas.
Dentro del diálogo de edición, podremos modificar la severidad de la regla, así como los parámetros que tenga asociados. Una vez realizados los cambios necesarios, pulsamos en Editar regla para guardar.
5.5 Colecciones #
Las colecciones son una forma de agrupar APIs que permite trabajar de forma más sencilla. Es importante tener en cuenta que, las guías de estilos, se aplican sobre una colección por lo que, todas las APIs que pertenezcan a una misma colección, se escanearán con la misma guía de estilos.
Se puede acceder a “Colecciones” desde el menú de configuración. Se pueden crear tantas colecciones como se deseen y en cada una de ellas se pueden agregar todas las APIs necesarias.
Una vez se accede a “Colecciones” desde el menú de configuración, aparece un listado con las colecciones ya existentes, el número de APIs que contiene la colección, la guía de estilo, las calificaciones que tiene la colección y un botón para crear Nueva colección. También podremos editar, actualizar y eliminar la colección deseada.
Cabe destacar que una vez hecho el registro y creada una cuenta con su correspondiente organización también se crea por defecto una colección por lo que, cuando se acceda por primera vez a “Colecciones” aparecerá la primera creada por defecto.
5.5.1. Crear nueva colección #
Para empezar a crear nuevas colecciones hay que hacer clic en el botón Nueva colección.
Una vez se ha hecho clic, se abrirá un formulario donde se nos pedirá introducir un nombre (obligatorio) y seleccionar la guía de estilos que se aplicará en el escaneo de las APIs, así como un apartado de descripción de la misma. Es importante recordar que, si no se selecciona ninguna guía de estilos, se aplicará la que hayamos marcado como predeterminada.
5.5.1. Detalle colección #
Cada una de las colecciones creadas se puede editar o eliminar desde los iconos que aparecen a la derecha de cada colección. Se debe tener en cuenta que no se podrá eliminar una colección que está asociada a una API.
Se puede acceder a la guía de estilos asociada a cada colección creada desde el enlace de dicha guía.
También se puede acceder al detalle de una colección haciendo clic en el enlace de dicha colección.
En el detalle de cada colección se pueden observar todas las APIs que pertenecen a ella y además se pueden crear más mediante el botón Importar API aunque, como veremos en el apartado 6, también podremos hacerlo desde el Explorador de APIs.
5.5.2. Reporte de la colección #
Una vez se ha subido por lo menos una API en la colección y se ha ejecutado la el ciclo de API First, se generará un reporte de la colección, que nos muestra tanto las notas globales de la colección y las notas individuales de cada API.
En la sección de cada API se puede acceder al reporte completo con más información. Sección 6.2.2.1.
Se debe tener en cuenta que hasta que no hayamos asignado una API a nuestra colección, no podremos tener un reporte de colecciones.
5.6 Ramas y pipelines #
Se puede acceder a la pantalla “Ramas y pipelines” desde el menú de configuración. En la misma podremos hacer modificaciones del ciclo de API First tanto en desarrollo como en producción. aunque debemos tener en cuenta que en producción solo podremos modificar con que API Manager queremos desplegar.
5.6.1 Editar rama #
Para editar o modificar el ciclo de API First en el entorno de desarrollo, haremos clic sobre el icono de editar, el cual nos llevará a la vista de edición de la rama.
En esta vista, vemos los stages disponibles para incluir en el ciclo de API First, estas herramientas están agrupadas por categorías. Cada herramienta puede añadirse al ciclo, eliminarla del ciclo, editarla y en los casos de Microcks, Sonarqube y Newman se podrá activar o desactivar la puntuación que se calcula. Esta calificación si está activada, será parte de la nota que calculamos para la API.
5.6.1.1 Editar pipeline #
Dentro de cada rama, podemos editar la pipeline que se ejecutará. Para ello tenemos que hacer clic en el botón de Ciclo de API First.
Se abrirá un editor de texto con el yaml actual de la pipeline y que podemos modificar. Una vez modificada, hacemos clic en guardar los cambios realizados
5.6.1.2 Editar stage #
Además de editar la pipeline, cada stage se puede modificar dando clic en “Editar stage” dentro del menú de configuración. Al editar se nos abrirá un editor de texto para modificar el yaml que se ejecutará.
5.6.1.3 Agregar stage #
En el entorno de desarrollo se pueden añadir nuevos stage según las necesidades de la organización. colocaremos nombre y descripción de la misma y escribiremos en el editor de texto el código yml del stage personalizado.
5.7 Cuentas #
Se puede acceder a la pantalla “Cuentas” desde el menú de configuración.
En este apartado, por un lado, se pueden vincular las aplicaciones para integrarlas en API Quality y por otro lado se pueden vincular los repositorios para importar APIs desde ellos.
5.7.1 Aplicaciones #
Las aplicaciones que se pueden vincular son GitLab on Premise, SonarQube y Microcks.
Se debe tener en cuenta que para vincular GitLab on Premise no se debe tener ninguna API importada a la organización.
Además, es recomendable primero vincular GitLab on Premise y posteriormente SonarQube y Microcks para el funcionamiento correcto de la aplicación.
Para realizar la vinculación debemos rellenar el modal con los datos requeridos, los cuales son obligatorios.
5.7.2 Repositorios #
Para la vinculación con los repositorios: Gitlab, Github, Azure Devops y Bitbucker. para poder subir APIs desde ellos, haremos clic en el botón de vincular.
Podemos realizar la vinculación de dos formas para los repositorios Gitlab, Github y Azure Devops: Mediante Inicio de sesión en el navegador y Mediante personal access token.
Por el contrario, en BitBucket encontraremos solo la opción de vinculación mediante inicio de sesión en el navegador.
5.8 API Managers #
Se puede acceder a la pantalla “API Manager” desde el menú de configuración.
En este apartado se puede configurar aquellos API Managers en los que posteriormente queramos desplegar nuestras APIs. Siendo Apigee, Azure API Management, Mulesoft, AWS API Gateway, Kong y WSO2 los API Manager que hay disponibles para vincular.
Al hacer clic en el botón vincular se abrirá una ventana en la que nos solicitará la información de acceso para cada uno de ellos.
5.8.1 Apigee #
Para configurar el API Manager Apigee se debe hacer clic en el botón vincular.
Una vez se ha hecho clic se abre un formulario donde se deben rellenar los campos Nombre de usuario, contraseña y organización apigee. En este caso, los tres campos son obligatorios para poder hacer clic en el botón vincular y terminar el proceso.
Una vez está vinculado el APImanager, se puede editar la vinculación o eliminarla desde dichos iconos.
Figura 48 Editar/Eliminar Apigee
5.8.2 Azure API Management #
Para configurar el API Manager Azure API Management se debe hacer clic en el botón vincular.
Una vez se ha hecho clic se abre un formulario donde, en este caso, hay dos formas de vincular.
En primer lugar, si se elige la opción “Iniciar sesión en el navegador” se redirigirá la web de Azure para hacer login. Una vez hecho login en la web de API Quality se debe terminar de vincular rellenando el campo nombre de instancia en azure.
La segunda opción para vincular es elegir “Iniciar sesión mediante primary key” y rellenar todos los campos obligatorios que aparecen con esta opción que son ID de suscripción, nombre del grupo, identificador, API key y URL.
Una vez está vinculado el APImanager, se puede editar la vinculación o eliminarla desde dichos iconos.
5.8.3 Mulesoft #
Para configurar el API Manager Mulesoft se debe hacer clic en el botón vincular.
Una vez se ha hecho clic se abre un formulario donde se deben rellenar los campos tipo de autenticación Mulesoft y organización de Mulesoft. Una vez se rellena el campo tipo de autentificación aparecen dos campos más a rellenar que dependiendo de lo que se ha elegido se deberá rellenar el nombre de usuario o Client ID. El segundo campo a rellenar que aparece es la contraseña.
En este caso, todos los campos son obligatorios para poder hacer clic en el botón vincular y terminar el proceso.
Una vez está vinculado el API manager, se puede editar la vinculación o eliminarla desde dichos iconos.
5.8.4 AWS API Gateway #
Para configurar el API manager AWS API Gateway se debe hacer clic en el botón vincular.
Una vez se ha hecho clic se abre un formulario donde se deben rellenar los campos AWS ID y AWS Access Key. En este caso, ambos campos son obligatorios para poder hacer clic en el botón vincular y terminar el proceso.
Una vez está vinculado el API Manager, se puede editar la vinculación o eliminarla desde dichos iconos.
5.8.5 Kong #
Para configurar el API Manager Kong se debe hacer clic en el botón vincular.
En el caso de elegir default no se desplegará ningún campo más.
Una vez se ha hecho clic se abre un formulario donde se deben rellenar los campos tipo de autenticación Kong y URL los cuales son ambos obligatorios. Dependiendo del tipo de autenticación que se elija se desplegarán más campos.
En el caso de elegir JwtAuth hay que rellenar los campos algoritmo ,clave jwt y URL los campos son obligatorios para poder hacer clic en el botón vincular y terminar el proceso.
En el caso de elegir KeyAuth se debe rellenar el campo clave API el cual es obligatorio para poder hacer clic en el botón vincular y terminar el proceso.
En el caso de elegir Oauth2 credentials aparecerán los campos Client ID, clave de provisión, secreto de cliente y alcance. Todos ellos son obligatorios para poder hacer clic en el botón vincular y terminar el proceso.
Y por último, si se elige BasicAuth habrá que rellenar los campos nombre de usuario y contraseña ambos obligatorios para poder hacer clic en el botón vincular y terminar el proceso.
Una vez está vinculado el API Manager, se puede editar la vinculación o eliminarla desde dichos iconos.
5.8.6 WSO2 #
Para configurar el API Manager WSO2 se debe hacer clic en el botón vincular.
Una vez se ha hecho clic se abre un formulario donde se deben rellenar los campos nombre de usuario, contraseña y URL. En este caso, los tres campos son obligatorios para poder hacer clic en el botón vincular y terminar el proceso.
Una vez está vinculado el API Manager, se puede editar la vinculación o eliminarla desde dichos iconos.
Una vez que hemos vinculado el/los API Managers que queremos utilizar para desplegar las APIs de tu organización, visualizamos todos las url de los API Managers.
5.9 Developer portal #
Se puede acceder a la pantalla “Developer portal” desde el menú de configuración.
Al acceder a esta pantalla, aparecen dos pestañas las cuales redirigen a las subpantallas “Entorno” y ·Developer portal”.
5.9.1. Entorno #
La pantalla “Entorno” es la que aparece por defecto al acceder a developer portal.
Si aún no se ha añadido ningún entorno, debe aparecer un mensaje indicandolo y el botón añadir entorno en el centro de la pantalla.
Una vez se hace clic en añadir entorno se abre un formulario donde en primer lugar hay que elegir si el entorno se quiere vincular mediante primary key o mediante token. En segundo lugar, existen dos desplegables para elegir el API Manager y el entorno. Y por último, se deben rellenar los campos del formulario que estos cambiarán dependiendo de la forma de vinculación escogida anteriormente.
5.9.1. Developer portal #
La pantalla “Developer portal” es la segunda pestaña cuando se accede desde el menú. Haciendo clic en la pestaña se accede a dicha pantalla.
Si aún no se ha añadido ningún developer portal, debe aparecer un mensaje indicandolo y el botón añadir developer portal en el centro de la pantalla.
Es importante destacar que para añadir un developer portal se debe haber creado anteriormente un entorno ya que uno de los campos a rellenar en el formulario es elegir uno de los entornos creados.
Una vez se hace clic en añadir entorno se abre un formulario donde en primer lugar hay que elegir entre dos opciones: crear nuevo developer portal o vincular developer portal existente. En segundo lugar aparece el campo desplegable “entorno” para elegir uno de los entornos creados. Y por último, se deben rellenar los campos del formulario que estos cambiarán dependiendo de la forma escogida anteriormente de añadir un developer.
6. Explorador de APIs #
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.
6.1. 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.
6.2. 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.
6.2.1 Ciclo API First #
Estando en la rama development, para realizar el testeo de nuestra API, tenemos habilitados los siguientes apartados:
6.2.1.1 Calidad en definición – sonarqube: #
En este apartado podemos visualizar el archivo de definición asociado a la API, así como la calificación de nuestra API.
Al acceder al menú, podemos ejecutar , actualizar así como editar la definición demuestra API. Tendremos la opción de reescanear la API en caso de haber realizado modificaciones en la definición, así como visualizar los errores y vulnerabilidades dentro del propio fichero para tener una visión más clara del problema.
Podremos hacer modificaciones en la definición de nuestra API directamente para posteriormente guardarlo, para ello debemos acceder a el apartado de “Definición”
En el icono de la hamburguesa disponemos de distintas opciones, como son ocultar los detalles de los errores, opción de descarga, subir un archivo para su actualización (dispone de un desplegable con dos opciones: archivo local o URL), mostrar vista de swagger, mostrar vista editor.
Si seleccionamos vista de “Editor” podremos más cómodamente editar el archivo en la propia herramienta y guardar estos cambios: :
Si seleccionamos vista de Swagger:
En la vista del Swagger, saldrán las reglas que hemos definido en nuestra guía de estilos y que no se han cumplido. Haciendo clic en el nombre de la regla, se abrirá una vista con la explicación de la regla seleccionada con un ejemplo de compilación correcta y otro de incorrecta.
Por otra parte, en caso de querer reemplazar el fichero, podemos hacer clic en el botón “Subir fichero”, donde se nos abrirá el siguiente diálogo para elegir el origen de importación.
También tenemos la posibilidad de descargarnos el fichero de la API actual mediante la opción “Descargar”. Esto resulta útil en caso de haber editado la definición desde API Quality, y se quiere tener una copia local con los últimos cambios realizados.
6.2.1.2 Mock server – microcks #
Se puede visualizar un desplegable con la clasificación del índice y de la puntuación.
Podemos lanzar nuestra stage así como actualizarla.
Al hacer clic en la URL nos redirige a la página de microcks.
6.2.1.3 Contract tests – swagger2postman #
Permite generar colecciones postman para realizar pruebas.
En este apartado podemos generar nuestras colecciones de Postman. Para ello debemos pulsar en el botón Configuración y luego en Generar colecciones.
Al pulsar, se abrirá un diálogo donde se nos pedirá, con los campos obligatorios, en primer lugar, dar nombre al Host que queremos generar, a continuación el Puerto. Así también tenemos la opción de generar estos endpoint solo de lectura, y por último hacer clic en botón crear.
Una vez generadas las colecciones, tendremos la opción de descargarlas mediante el botón Descargar colecciones. Si quisiéramos, también se puede editar un entorno.
6.2.1.4 Pruebas de calidad – newman #
Realiza tests en base a una colección de postman.
Para terminar el ciclo de testing de nuestra API, debemos hacer clic en configuración tenemos disponible el apartado Pruebas de calidad – “newman”.
Para ejecutar un test, pulsaremos el botón Ejecutar test.
Figura 80. Ejecutar test Newman
A continuación, se abrirá un diálogo donde deberemos incluir tanto el fichero json de la colección Postman a examinar, como el fichero de entornos asociado a la misma para realizar el test, una vez subidas podremos lanzarlo,y actualizarlo,
:
Una vez generado el reporte, se mostrará una vista como la siguiente donde examinar los resultados:
Figura 82 . Reporte de Newman generado
6.2.1.5 Microservicios #
API Quality permite generar el arquetipo correspondiente a la definición importada en un lenguaje concreto. Este microservicio se encontrará disponible en el repositorio de definición de la API.
Para generar el arquetipo, deberemos elegir entre los lenguajes disponibles en la herramienta, actualmente Java Spring Boot o C#. NET, y pulsar el botón Generar. Es importante que la definición contenga la estructura correcta para que se pueda generar el arquetipo; en caso contrario, se obtendrá un error.
Para ello hacer clic en configuración, nos llevará a un apartado donde podremos seleccionar en qué lenguaje queremos utilizar
Una vez generado el arquetipo, se habilitará el botón Descargar, que permite tener una copia local del proyecto base.
6.2.1.6 Despliegue en Api Manager – kong, Despliegue en Api Manager – mulesoft, Despliegue en Api Manager – wso2:v4, Despliegue en Api Manager – wso2:v3, Despliegue en Api Manager – aws #
El último apartado del ciclo API First es el de despliegue. Para desplegar una API elegiremos el API Manager en la que queremos desplegarla, pulsaremos en el menú, se desplegará la opción de “Ejecutar stage” para su despliegue.
Para desplegar una API, pulsaremos el botón Desplegar API:
Esto abrirá un diálogo donde deberemos seleccionar el API Manager, dependiendo del que elegimos se desplegarán otras opciones donde deseamos desplegar nuestra API. Visualermos también Backend service URL, el cual no es obligatorio.
Una vez desplegada, comenzaremos a ver el estado en el que se encuentra nuestra API.
Haciendo clic en el icono de borrar, se nos abrirá un diálogo para confirmar que se desea eliminar la API desplegada.
Al intentar desplegar una API hay que tener en cuenta que solo estarán disponibles aquellos API Managers configurados previamente.
6.2.1.7 Developer portals #
En este apartado podremos publicar nuestra API, el cual ya hemos configurado previamente, como se desglosa en el punto 5.9
6.2.2 Información general #
En segundo lugar, se encuentra el apartado “Información general”.
Se puede acceder a la pantalla “Reporte”, haciendo clic en el icono azul que aparece a la derecha del título o en el enlace “Reporte”. También se puede acceder a dicho reporte desde la opción “Rating”, con el enlace al reporte.
Aquí, se puede encontrar una información general de la API.
Se puede cambiar la versión de la API. Haciendo clic en este campo se abre un desplegable para elegir otra versión o crear una nueva.
También se puede agregar y crear nuevas etiquetas, explicado en el punto .
Por último, aparecen los apartados donde están los enlaces de nuestras APIs de “Mock Server”, “Documentación” y “Repositorio de definición”, si estos no han sido desactivados como explicamos en el punto 5.1. Podemos ver las “Líneas”, “Esquemas”, “Rutas” así como “Número de operaciones” de la API escaneada.
6.2.2.1 Rating #
Podemos acceder al reporte de nuestra API que contiene su nota global y una nota por cada una de las herramientas que hayamos configurado. También podemos ver información general de la API como el número de líneas, de esquemas, de rutas y de operaciones. Disponemos de un enlace con información sobre nuestras notas/calificaciones.
En caso de existir, en la sección de “Definición” encontraremos un listado de los errores y vulnerabilidades de definición que contiene nuestra API en base a la guía de estilos.
6.2.2.2 Versionado de APIs #
Para ver o modificar el versionado de nuestras API, debemos acceder al el desplegable y modificar nuestra versión teniendo en cuenta la nomenclatura, de lo contrario nos dará error
7. Mi perfil #
Se puede acceder a “Mi perfil” desde el icono que aparece arriba a la derecha con forma del perfil de una persona. Al desplegarlo podremos acceder a nuestro perfil así como la opción de cerrar sesión
Una vez accedemos en la opción “Mi perfil” en esta pantalla por un lado se pueden encontrar los datos personales como el nombre, apellidos o idioma. Estos tres campos pueden ser editados donde en el caso del nombre y apellidos se pueden cambiar los datos deseados en dicho campo y en el caso del idioma con el desplegable se puede elegir español o inglés. Para guardar estos cambios siempre se debe hacer clic en Guardar cambios.
Por otro lado, se encuentran los datos de acceso como correo electrónico el cual también puede ser modificado. Al modificar este y guardar cambios, debe llegar un correo electrónico al nuevo para verificarlo.
La contraseña también se puede modificar rellenando los campos contraseña y nueva contraseña y haciendo clic en el botón Guardar cambios.
