Definición de esquemas para una API

Editar en línea

Los componentes de esquema definen esquemas reutilizables que proporcionan a los desarrolladores información relativa a la solicitud que deben realizar o a la respuesta que deben esperar recibir al llamar a una operación de API.

Acerca de esta tarea

Nota: Esta tarea está relacionada con la configuración de una definición de API de OpenAPI 2.0 . Para obtener detalles sobre cómo configurar una definición de API de OpenAPI 3.0 , consulte Edición de una definición de API de OpenAPI 3.0.

Una API creada en OpenAPI 2.0 incluye una sección en la que se definen las definiciones de la carga útil de la API. Las definiciones de la carga útil describen la estructura de los datos transmitidos en las solicitudes y respuestas de la API, utilizando una variante especializada del esquema JSON específica de OpenAPI. Cada definición de carga útil se corresponde con un esquema, que enumera los campos de datos previstos. Estos campos de datos se representan como propiedades dentro del esquema e incluyen un conjunto de atributos que describen su tipo, los valores permitidos, su carácter obligatorio y otras características. Aunque hay numerosos atributos disponibles, la mayoría de ellos se utilizan con poca frecuencia.

Puede completar esta tarea utilizando la aplicación de interfaz de usuario de API Designer o utilizando la interfaz de usuario de API Manager basada en navegador.

En cualquier momento, puedes pasar directamente al código fuente YAML de « OpenAPI » haciendo clic en el icono «Fuente Icono OpenAPI Source». Para volver al formulario de diseño, haz clic en el icono del formulario Icono de formulario.

Procedimiento

  1. Abra la API para editarla, tal como se describe en Edición de una definición de API de OpenAPI 2.0.
  2. Si ya hay uno o varios esquemas definidos, expanda Definiciones.
  3. Puede crear un esquema nuevo o editar cualquier esquema existente.
    • Para crear un esquema, haz clic en el icono de añadir OpenAPI 2.0 Icono de adición de API situado junto a «Definiciones » y, a continuación, consulta la sección «Creación de definiciones de esquema ».
    • Para editar un esquema existente, haz clic en el nombre del componente del esquema en el panel de navegación y, a continuación, consulta la sección «Edición de definiciones de esquemas ».