Tutorial: Definición de metadatos personalizados

En este tutorial se explica cómo definir metadatos personalizados para ayudarle a organizar las API y otra información en el centro de API. Puede usar metadatos personalizados e integrados para buscar y filtrar y aplicar estándares de gobernanza en su organización.

Para más información sobre los metadatos en el Centro de API de Azure, consulte:

• Conceptos clave: metadatos
• Uso de metadatos para la gobernanza de API

En este tutorial, aprenderá a usar Azure Portal para:

• Definición de metadatos personalizados en el centro de API
• Visualización del esquema de metadatos

Prerrequisitos

• Un centro de API en la suscripción de Azure. Para crear una, consulte Inicio rápido: Creación del centro de API.

Definición de metadatos

Aquí se definen dos ejemplos de metadatos personalizados: Línea de negocio y Público; si lo prefiere, defina otros metadatos propios. Al agregar o actualizar las API y otra información en su inventario, establezca valores para metadatos personalizados y cualquier metadato común incorporado.

Importante

No incluya ninguna información confidencial ni personal en los títulos (nombres) de los metadatos que defina. Estos títulos son visibles en los registros de supervisión que Microsoft usa para mejorar la funcionalidad del servicio. Sin embargo, otros detalles y valores de metadatos son los datos protegidos del cliente.

1. Inicie sesión en Azure Portal y vaya al centro de API.

2. En el menú de la barra lateral, en Recursos, seleccioneMetadatos>+ Nuevos metadatos.

3. En la pestaña Detalles , escriba información sobre los metadatos.

   1. En Título, escriba Línea de negocio.

   2. Si lo desea, escriba una descripción.

   3. Seleccione Opciones predefinidas y escriba opciones como Marketing, Finanzas, TI, Ventas, etc. Opcionalmente, habilite Permitir selección de varios valores. Seleccione Siguiente.

   

4. En la pestaña Asignaciones , seleccione Obligatorio para las API. Seleccione Opcional para Implementaciones y entornos. Puede agregar estas entidades en tutoriales posteriores. Seleccione Siguiente.

   

5. En la pestaña Revisar y crear , revise la configuración y seleccione Crear.

   Los metadatos se agregan a la lista en la página Metadatos .

6. Seleccione + Nuevos metadatos para agregar otro ejemplo.

7. En la pestaña Detalles , escriba información sobre los metadatos.

   1. En Título, escriba Orientado al público.

   2. Seleccione tipo Boolean.

8. En la pestaña Asignaciones , seleccione Obligatorio para las API. Seleccione No aplicable para Implementaciones y entornos.

9. En la pestaña Revisar y crear , revise la configuración y seleccione Crear.

   Los metadatos se agregan a la lista.

Visualización del esquema de metadatos

Puede ver y descargar el esquema JSON de los metadatos definidos en el centro de API. El esquema incluye metadatos integrados y personalizados.

1. En el menú de la izquierda, en Recursos, seleccioneMetadatos >Ver esquema de metadatos.

2. Seleccione Ver esquema de metadatos>API para ver el esquema de metadatos de las API, que incluye metadatos integrados y personalizados. También puede ver el esquema de metadatos definido para implementaciones y entornos en el centro de API.

   

Paso siguiente

Agregue las API al inventario en el centro de API.

Registrar API en el inventario de API