Especificación de documentación externa para una operación

Puede hacer referencia a un recurso externo para ampliar la documentación de una operación de API.

Acerca de esta tarea

Nota:

• Esta tarea está relacionada con la configuración de una definición de API OpenAPI 3.0. Para obtener detalles sobre cómo configurar una definición de API de OpenAPI 2.0 , consulte Edición de una definición de API de OpenAPI 2.0.
• Las API de OpenAPI 3.0 solo están soportadas con DataPower® API Gateway, no con DataPower Gateway (v5 compatible).
• Para obtener detalles sobre las limitaciones actuales del soporte de OpenAPI 3.0 , consulte el soporte de OpenAPI 3.0 en IBM® API Connect.

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, puede conmutar directamente al origen YAML OpenAPI subyacente pulsando el icono Origen . Para volver al formulario de diseño, pulse el icono Formulario .

1. Abra la API para editarla, tal como se describe en Edición de una definición de API de OpenAPI 3.0.
2. Expanda Vías de accesoy, a continuación, expanda la vía de acceso necesaria.
3. Expanda Operaciones, expanda la operación necesaria y, a continuación, pulse Documentación externa.
4. Especifique 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.
5. Haga clic en Guardar cuando haya terminado.