Tutorial: Definición de metadatos personalizados

En este tutorial, defina metadatos personalizados para ayudarle a organizar las API y otra información en el centro de API. Use metadatos personalizados e integrados para buscar y filtrar y aplicar estándares de gobernanza en su organización.

Para obtener información general sobre los metadatos en Azure API Center, consulte:

• Conceptos clave
• Metadatos para la gobernanza de API

En este tutorial, aprenderá a usar el portal para:

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

Requisitos previos

• Un centro de API en la suscripción de Azure. Si aún no ha creado uno, 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 Orientados al público; si lo prefiere, defina otros metadatos propios. Al agregar o actualizar las API y otra información del inventario, establecerá los valores de los metadatos personalizados y los metadatos integrados comunes.

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. En Azure Portal vaya al centro de API.

2. En el menú de la izquierda, 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 el tipo 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 Requerido para las API. Seleccione Opcional en Implementaciones y entornos. (Agregará estas entidades en tutoriales posteriores.) Seleccione Next (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 Orientada al público.

   2. Seleccione el tipo Booleano.

8. En la pestaña Asignaciones, seleccione Requerido 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 para los metadatos 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.

   

Pasos siguientes

En este tutorial, aprenderá cómo usar el portal para:

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

Ahora que ha preparado el esquema de metadatos, agregue las API al inventario en el centro de API.

Registrar API en el inventario de API