Extensiones de OpenAPI

Las siguientes extensiones están disponibles en DeveloperHub.

x-tagGroups

x-tagGroups agrupa las operaciones en el índice y crea una jerarquía adicional. Esta función solo está habilitada si el índice está configurado como contraíble.

Los grupos de etiquetas se pueden definir de la siguiente manera en OpenAPI:

x-enum-varnames

x-enum-varnames proporciona un nombre secundario para un enum.

Los nombres de variables de enum se pueden definir de la siguiente manera en OpenAPI:

Variables

Además de usar variables en las referencias de la API, también se pueden usar estas variables:

• %_.project.base_path% para la ruta base del proyecto.

• %_.version.slug% para el slug de la versión.

• %_.section.slug% para el slug de la referencia de la API.

Estas variables son especialmente útiles para construir enlaces dentro de las descripciones en markdown.

x-labels

x-labels añade una o más etiquetas a la descripción de una propiedad de un esquema.

Las etiquetas se pueden definir de la siguiente manera en OpenAPI:

Cuando se establece x-labels, cada etiqueta se coloca en la descripción, sin estilo, usando el texto proporcionado. A cada etiqueta se le asignan las clases CSS label y el valor de type. Esto se puede usar para añadir etiquetas específicas con colores específicos, como insignias en una descripción.