Made in DeveloperHub
La combinación de referencias de API le permite unir varias definiciones de API existentes en una única referencia de API combinada. Esto es útil cuando la superficie de su API está repartida entre varios servicios o archivos, pero desea que los lectores consulten una referencia unificada.
El resultado combinado se guarda como una referencia de API en borrador para que pueda revisarla antes de publicarla.
Combinar referencias de API
Para crear una referencia de API combinada:
En la navegación superior del editor, abra el menú de la sección.
Haga clic en + New API reference.
Elija Merge references.
(Opcional) Añada una Override API Reference.
Seleccione de la lista las referencias de API que desea combinar (de la versión actual).
Establezca el orden de combinación con las flechas arriba y abajo situadas junto a cada referencia.
Haga clic en Merge. La referencia de API combinada se creará en estado borrador.
Override API Reference
La Override API Reference es una definición OpenAPI opcional que tiene prioridad sobre todo lo demás en la combinación. Puede proporcionarse en formato JSON o YAML. Úsela para sobrescribir partes específicas del resultado combinado, por ejemplo:
info(incluidostitle,descriptionyversion)Cualquier componente, esquema y definición de seguridad que desee que prevalezca en caso de conflicto
La Override API Reference debe incluir la versión openapi. En la práctica, también se espera que info, description y version se sobrescriban aquí.
Ejemplo de Override API Reference
Esta sobrescritura establece el título y la versión de la API, y reemplaza el esquema de seguridad bearerAuth.
Orden de combinación y precedencia
Puede elegir entre las referencias de API que ya existen en la versión que está editando actualmente.
La precedencia se determina por el orden de la lista:
Las referencias situadas antes en la lista tienen prioridad.
Las referencias situadas después en la lista (con un número de orden mayor) sobrescriben a las anteriores cuando hay un conflicto.
Los conflictos se resuelven por nombre. Si el mismo nombre existe en varias referencias, las posteriores sobrescriben a las anteriores, por ejemplo:
Componentes
Esquemas
Esquemas de seguridad (y otros objetos con nombre relacionados con la seguridad)
Para cambiar la precedencia, use las flechas arriba y abajo junto a cada referencia de la lista.
Requisitos
Todas las definiciones de API de la combinación deben usar exactamente la misma versión de OpenAPI.