Edición de definiciones de esquema

Los esquemas proporcionan a los desarrolladores información sobre la solicitud que deben realizar, o la respuesta que deben esperar recibir, al llamar a una operación de API. Puede editar esquemas creados anteriormente en diversas áreas de la definición de API.

Puede configurar los siguientes valores de definición de esquema:

• Nombre de esquema: este nombre define una clave que permite que se haga referencia a este esquema desde cualquier otro lugar de la definición de API; la referencia tiene el formato siguiente:

  #/definitions/Name

  Para cambiar el nombre, pulse el icono Origen , cambie el valor en el campo y, a continuación, pulse Guardar.
• Opcional: Título: El título del esquema.
• Tipo: el tipo de datos de esquema; seleccione uno de los siguientes:
  • • matriz
    • Boolean
    • entero
    • número
    • objeto
    • serie

  Nota: Si cambia el tipo de un esquema existente, los valores existentes que no son relevantes para el nuevo tipo se conservarán en el origen OpenAPI aunque ya no se muestren en la interfaz de usuario. Por lo tanto, debe evitar portar un esquema de un tipo a otro pero, en su lugar, debe crear un nuevo esquema o modificar directamente el origen OpenAPI ; para abrir el editor de origen, pulse el icono Origen .
• Propiedades: la propiedad de esquema. Para añadir una propiedad al esquema, pulse Añadir junto a la cabecera de sección Propiedades , complete los detalles y pulse Guardar.
• Valores de esquema adicionales que dependen del Tipo de propiedad seleccionado. Para ver y editar estos valores de esquema, pulse el menú Opciones junto a la propiedad que desea ver y seleccione Detalles.
  • boolean: sin valores específicos de tipo.
  • entero:
    • Formato: un modificador de tipo de datos opcional. Para obtener más información, consulte Tipos de datos en la especificación OpenAPI.
    • Múltiplo de: la división de una instancia de integer por este valor debe generar un entero.
    • Máximo: una instancia de integer debe ser inferior o igual a este valor.
    • Máximo excluyente: una instancia de integer debe ser estrictamente inferior a este valor.
    • Mínimo: una instancia de integer debe ser superior o igual a este valor.
    • Mínimo excluyente: una instancia de integer debe ser estrictamente superior a este valor.
  • número:
    • Formato: un modificador de tipo de datos opcional. Para obtener más información, consulte Tipos de datos en la especificación OpenAPI.
    • Múltiplo de: la división de una instancia de number por este valor debe generar un entero.
    • Máximo: una instancia de number debe ser inferior o igual a este valor.
    • Máximo excluyente: una instancia de number debe ser estrictamente inferior a este valor.
    • Mínimo: una instancia de number debe ser superior o igual a este valor.
    • Mínimo excluyente: una instancia de number debe ser estrictamente superior a este valor.
  • objeto:
    • Número máximo de propiedades: el número de propiedades de una instancia de object debe ser inferior o igual a este valor.
    • Número mínimo de propiedades: el número de propiedades de una instancia de object debe ser superior o igual a este valor.
    • Propiedades necesarias: una matriz de nombres de propiedad; cada nombre de propiedad de la matriz debe ser el nombre de una propiedad de una instancia de object. Para añadir un nombre de propiedad necesaria, pulse Añadir junto a la cabecera de sección Propiedades necesarias, especifique el nombre y, a continuación, pulse Crear.
  • serie:
    • Formato: un modificador de tipo de datos opcional. Para obtener más información, consulte Tipos de datos en la especificación OpenAPI.
    • Patrón: una expresión regular; una instancia de string debe coincidir exactamente con la expresión.
    • Longitud máxima: el número máximo de caracteres permitido en una instancia de string.
    • Longitud mínima: el número mínimo de caracteres permitido en una instancia de string.
    • Enum: una matriz de valores de serie; una instancia de string debe coincidir con uno de los valores de matriz. Para añadir un valor de enumeración, pulse Añadir, especifique el valor y, a continuación, pulse Crear.
• Valores generales; seleccione las opciones necesarias:
  • Necesario: es necesaria una propiedad asociada con este esquema.
  • Solo lectura: una propiedad asociada con este esquema puede devolverse en una respuesta, pero no debe incluirse en una solicitud. Por ejemplo, las propiedades cuyos valores sean identificadores generados por el sistema se definirán como Solo lectura porque los clientes de aplicación no podrán establecerlas.
• Valor de ejemplo: un valor de ejemplo. Lo que especifique aquí se mostrará tal cual en el Portal del desarrollador.
• Documentación externa: un recurso externo para la documentación ampliada; proporcione la información siguiente:
  • URL (obligatorio): el URL de la documentación de destino.
  • Descripción: una descripción opcional de la documentación de destino. Puede utilizar la sintaxis CommonMark para la representación de texto enriquecido.
• Xml: Metadatos que permiten definiciones de modelo XML más ajustadas; proporcione la información siguiente:
  • Nombre: Sustituye el nombre del elemento o atributo que se utiliza para la propiedad de esquema descrita.
  • Espacio de nombres : La dirección URL de la definición del espacio de nombres.
  • Prefijo: el prefijo que se utilizará para el Nombre.
  • Atributo: Especifica si la definición de propiedad se convierte en un atributo en lugar de un elemento.
  • Encapsulado: para una definición de matriz, especifica si la matriz está encapsulada (por ejemplo, <books><book/><book/></books>) o no encapsulada (<book/><book/>).
• Haga clic en Guardar cuando haya terminado.