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.
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.
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.
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.
