Gestión de referencias de API

DeveloperHub genera referencias de API atractivas y potentes a partir de tus archivos de especificación de API. Consulta nuestra demostración de Swagger Petstore aquí.

Consulta Carga de referencias para aprender cómo añadir una referencia de API a tu versión.

Gestionar secciones

Las referencias de API y las secciones de documentación se encuentran en la misma página Gestionar secciones. Para abrirla:

• En la navegación superior del editor, haz clic en el menú de secciones.

• Haz clic en el engranaje de configuración .

La lista de la izquierda agrupa las secciones bajo los encabezados Documentación y Referencia de API. Selecciona una referencia de API para ver y editar su configuración a la derecha.

Creación de referencias de API

Para crear una referencia de API:

1. Abre el menú de secciones en la navegación superior.

2. En el grupo Referencia de API, haz clic en + Nueva referencia de API.

3. Elige una opción:

   • Crear desde cero: comienza con una definición OpenAPI vacía.

   • Cargar definición OpenAPI: carga un archivo existente. Consulta Carga de referencias.

   • Combinar referencias: combina dos o más referencias existentes. Consulta Combinación de definiciones de API.

Eliminación de referencias de API

Para eliminar una referencia de API:

• Abre Gestionar secciones.

• Selecciona la referencia de API.

• En la tarjeta Zona de peligro, haz clic en Eliminar sección.

• Confirma la eliminación.

Ordenación de referencias de API

Para cambiar el orden de una referencia de API en el selector:

• Abre Gestionar secciones.

• Arrastra la referencia en la lista de la izquierda desde el control .

• Suelta la referencia en la posición deseada.

Solo puedes reordenar dentro del grupo Referencia de API; no se admite arrastrar y soltar entre Documentación y Referencia de API.

Si la referencia está en primer lugar, está publicada y no hay documentaciones, será la referencia que se cargue de forma predeterminada para tus lectores.