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

Editar en línea

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 de OpenAPI 2.0 . Para obtener detalles sobre cómo configurar una definición de API de OpenAPI 3.0 , consulte Edición de una definición de API de OpenAPI 3.0.

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, puedes pasar directamente al código fuente YAML de « OpenAPI » haciendo clic Icono OpenAPI Source en el icono «Fuente ». Para volver al formulario de diseño, haz clic en el icono del formulario Icono de formulario.

Procedimiento

  1. Abra la API para editarla, tal como se describe en Edición de una definición de API de OpenAPI 2.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. Puedes utilizar la sintaxis CommonMark para la representación de texto con formato.
  5. Haga clic en Guardar cuando haya terminado.