Esta página se aplica a Apigee y Apigee Hybrid.
En la página API, se proporciona información detallada sobre una API. Cuando seleccionas una API de la página de la lista de APIs, se muestra la pestaña Descripción general.
La pestaña Descripción general tiene las siguientes secciones:
General
En el panel general, se muestra información de nivel superior sobre una API, incluido lo siguiente:
- Nombre visible: Nombre visible de la API. Se define cuando se registra la API. Para editar el nombre visible, consulta Edita los detalles del registro de la API.
- Descripción: Es la descripción de la API. Se define cuando se registra la API. Para editar la descripción, consulta Edita el registro de detalles de la API.
- Elementos de taxonomía personalizados y del sistema
- Versión del documento: Un vínculo que abre la revisión de la especificación que se encuentra asignada actualmente a la implementación. Este botón aparece solo si la API tiene un conjunto de implementaciones recomendadas y esa implementación tiene una versión asignada.
- Obtener acceso: Proporciona instrucciones para acceder a esta API. Para modificar estas instrucciones, consulta Edita la implementación. Este botón solo aparece cuando hay un conjunto de implementaciones recomendadas.
Si se adjuntan etiquetas desconocidas a través de la API pública, no se mostrarán en la IU. Solo se muestran las etiquetas que definen taxonomías conocidas.
A los valores de la taxonomía se les puede asignar una descripción de texto o una URL. En este panel, si a un valor de taxonomía se le asigna una descripción de texto, se muestra un ícono de información junto al valor que muestra la descripción cuando se coloca el cursor sobre él. Si el valor es una URL, el valor de la taxonomía que se muestra se convierte en un hipervínculo que abre la URL en una pestaña nueva del navegador. Consulta Agrega taxonomía para obtener más información.
Edita una API
Consulta Edita los detalles del registro de la API.
Borra una API
Consulta Borra la API.
Cuadro de evaluación
Los cuadros de evaluación permiten que los equipos comprendan cómo se midió la calidad de una API. En una cartera de API, un enfoque detallado para la puntuación puede ayudar a impulsar la coherencia en diferentes áreas, como los estándares de diseño, los perfiles de seguridad, la confiabilidad y otras dimensiones importantes para la empresa. El concentrador de la API integra el análisis con lint de OpenAPI ya configurado.
Un cuadro de evaluación representa un grupo de puntuaciones que no se reducen con facilidad a una sola cantidad.
Una puntuación es un valor único que representa algún aspecto de la calidad de una API. La calidad se puede definir en cualquier contexto (diseño, confiabilidad, cumplimiento, etc.) y, a menudo, es una cuestión de opiniones.
Oculta el cuadro de evaluación
Si deseas ocultar la IU del cuadro de evaluación para cada API, consulta Inhabilita o habilita el cuadro de evaluación de la API.
Selecciona una versión del cuadro de evaluación
Selecciona la versión que se usará para el cuadro de evaluación en la lista desplegable Puntuación de esta especificación:
Aquí:
- Más reciente: esta revisión de especificación tiene la marca de tiempo de carga más reciente.
- Recomendación: Esta especificación tiene una de sus revisiones asignadas a la implementación recomendada. Usa estas especificaciones si eres un consumidor de la API.
Personaliza el cuadro de evaluación
Para personalizar y configurar el cuadro de evaluación, usa la herramienta de línea de comandos de registro.
Consulta también: ¿Cómo se calculan las puntuaciones?
Si deseas mostrar un ícono de estado junto a los errores y advertencias en el cuadro de evaluación, define los umbrales de la siguiente forma:
Aquí:
| Tipo | Ícono | Descripción |
|---|---|---|
| Alerta |  |
Se muestra este ícono cuando el umbral está dentro del rango definido para las alertas. |
| Advertencia |  |
Se muestra este ícono cuando el umbral está dentro del rango definido para advertencias. |
| Aceptar |  |
Se muestra este ícono cuando el umbral está dentro del rango definido para aceptarlo. |
Resumen de lint
La configuración predeterminada del cuadro de evaluación del concentrador de la API informa las advertencias y los errores de lint en las especificaciones de OpenAPI v2 y Open v3 que se subieron al concentrador de la API. El concentrador y el registro de la API incluyen un linter predeterminado basado en Spectral. Este linter se proporciona como un ejemplo de referencia de las capacidades de análisis con lint (sin espera de que sea compatible con Spectral) mediante el conjunto de reglas de OpenAPI, con algunas excepciones habilitadas para reducir el ruido de los errores comunes. Actualmente no se admite la extensión con lints personalizados.
Consulta las Guías de estilo de la API en el registro para obtener instrucciones sobre cómo actualizar la configuración de linter.
Objetos Deployment
La pestaña Implementaciones muestra todas las implementaciones de la API que configuró el Editor de API. Las implementaciones representan entornos en vivo en los que se implementa la API. Las implementaciones se ordenan (de manera descendente) por el nombre del entorno. Se muestra la siguiente información:
- Entorno
- Documentación
- Indicador de implementación recomendada
- Puerta de enlace
- Orientación sobre el uso
- Canal externo
- Obtén acceso
Para obtener más información, consulta Administra implementaciones.
Versiones
La pestaña Versiones muestra todas las versiones definidas para la API. Las versiones se ordenan (de manera descendente) por número de versión. Se muestra la siguiente información:
- Versión
- Etapa del ciclo de vida
- Última revisión
- Final del ciclo de vida
Para obtener más información, consulta Administra versiones.
Relacionados
En el panel Información relacionada, que se muestra en la parte inferior de la página Descripción general de la API, se proporcionan vínculos a información diversa relacionada con la API. Por ejemplo, el código fuente de la implementación, la documentación de diseño y los sistemas de infraestructura. Para obtener más información, consulta Información relacionada.
Dependencias
En el panel Dependencias, que se muestra en la parte inferior de la página Descripción general de la API, se enumeran todas las dependencias de la API, incluidas otras APIs internas (presentes en el concentrador de APIs), APIs externas de terceros (no están presentes en el concentrador de APIs) y otros sistemas de producción. Por ejemplo, bases de datos y soluciones de almacenamiento. Para obtener más información, consulta Dependencias.
Próximos pasos
- Administra versiones
- Administrar las implementaciones
- Administrar revisiones
- Cómo declarar dependencias