Compartir por


Personalización del portal del Centro de API

En este artículo se explica la configuración que puede personalizar en el portal del Centro de API (versión preliminar). El portal del Centro de API es un sitio web administrado por Azure que los desarrolladores y otras partes interesadas de la organización usan para detectar las API en el centro de API.

Para configurar el portal del Centro de API para el uso inicial y el inicio de sesión, consulte Configuración del portal del Centro de API.

Nota:

El portal del Centro de API está actualmente en versión preliminar.

Página de configuración del portal

Configure la configuración del portal del Centro de API en Azure Portal. Para acceder a la página de configuración:

  1. Navegue hasta su centro de API en Azure Portal.
  2. En el portal del Centro de API, seleccione Configuración.
  3. Haga clic en las pestañas para ver y personalizar la configuración.
  4. Seleccione Guardar y publicar para aplicar los cambios.

Captura de pantalla de la configuración del portal del Centro de API en Azure Portal.

Importante

Seleccione Guardar y publicar cada vez que realice cambios en la configuración. Hasta que se publique, los cambios no estarán visibles en el portal del Centro de API.

Perfil del sitio

En la pestaña Perfil de sitio , proporcione opcionalmente un nombre personalizado que aparezca en la barra superior del portal publicado.

Captura de pantalla del nombre personalizado en el portal del Centro de API.

Visibilidad de la API

En la pestaña Visibilidad de api, controle qué API son detectables (visibles) para los usuarios del portal del Centro de API. La configuración de visibilidad se aplica a todos los usuarios del portal del Centro de API.

El portal del Centro de API usa la API del plano de datos de Azure API Center para recuperar y mostrar las API en el centro de API y, de forma predeterminada, muestra todas las API para los usuarios que han iniciado sesión con permisos de RBAC de Azure.

Para que solo las API específicas sean visibles, agregue condiciones de filtro para las API basadas en propiedades integradas. Por ejemplo, elija mostrar las API solo de determinados tipos (como REST o GraphQL) o en función de determinados formatos de especificación (como OpenAPI).

Captura de pantalla de la adición de condiciones de visibilidad de API en el portal.

Acceso anónimo

En la pestaña Visibilidad de api, opcionalmente, habilite el acceso de lectura anónimo a la API del plano de datos del Centro de API de Azure, que permite a los usuarios no autenticados detectar el inventario de API mediante llamadas directas a la API. Por ejemplo, habilite esta configuración para que las API se puedan detectar en usuarios no autenticados al hospedar automáticamente el portal del Centro de API.

Precaución

Al habilitar el acceso anónimo, tenga cuidado de no exponer información confidencial en definiciones o configuraciones de API.

Si se habilita en la pestaña Búsqueda semántica , el portal del Centro de API complementa la búsqueda de API básica basada en nombres con búsqueda semántica asistida por IA basada en nombres de API, descripciones y metadatos opcionalmente personalizados. La búsqueda semántica solo está disponible en el plan Estándar .

Los usuarios pueden buscar API mediante consultas de lenguaje natural, lo que facilita la búsqueda de API en función de su intención. Por ejemplo, si un desarrollador busca "Necesito una API para la administración del inventario", el portal puede sugerir API pertinentes, incluso si los nombres o descripciones de la API no incluyen esas palabras exactas.

Sugerencia

Al usar el plan gratis del Centro de API de Azure, puede actualizar fácilmente al plan Estándar para habilitar características de servicio completas, incluida la búsqueda semántica en el portal del Centro de API.

Para usar la búsqueda asistida por IA al iniciar sesión en el portal del Centro de API, haga clic en el cuadro de búsqueda, seleccione Buscar con IA y escriba una consulta.

Captura de pantalla de los resultados de búsqueda semántica en el portal del Centro de API.

Metadatos personalizados

En la pestaña Metadatos , seleccione opcionalmente las propiedades de metadatos personalizadas que quiera exponer en los detalles de la API y la búsqueda semántica.

Habilitación del acceso a la consola de prueba para las API

Puede configurar las opciones de usuario para autorizar de forma granular el acceso a las API y sus versiones específicas en el centro de API. Por ejemplo, configure determinadas versiones de API para usar claves de API para la autenticación y cree una directiva de acceso que permita que solo usuarios específicos se autentiquen mediante esas claves.

Las directivas de acceso también se aplican a la funcionalidad "Probar esta API" para las API en el portal del Centro de API, lo que garantiza que solo los usuarios del portal con la directiva de acceso adecuada puedan usar la consola de prueba para esas versiones de API. Más información sobre cómo autorizar el acceso a las API