Definición de operaciones para una vía de acceso

Las operaciones de una vía de acceso definen los mecanismos disponibles para interactuar con la API cuando se llama a esta utilizando esa vía de acceso. Una operación puede ser de diversos tipos predefinidos; por ejemplo, una operación POST se utiliza habitualmente para crear recursos, mientras que una operación GET se utiliza para recuperar un recurso.

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 Icono OpenAPI Source. Para volver al formulario de diseño, pulse el icono 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 3.0.
  2. Expanda Vías de acceso.
  3. Expanda la vía de acceso necesaria y, a continuación, si hay una o más operaciones, expanda Operaciones.
  4. Para crear una operación, pulse el icono Añadir OpenAPI 3.0 Icono de adición de API junto a Operaciones bajo la vía de acceso en el panel de navegación. Para editar una operación existente, pulse el nombre de la operación bajo la vía de acceso en el panel de navegación.
  5. Especifique la información siguiente:
    • Verbo: seleccione el tipo de operación entre las opciones siguientes:
      1. get
      2. post
      3. put
      4. delete
      5. options
      6. empleado
      7. parche
      8. Rastreo
    • Resumen: resumen de la función realizada por la operación.
    • Descripción: una descripción del comportamiento de la operación. Puede utilizar la sintaxis CommonMark para la representación de texto enriquecido.
    • ID de operación: serie exclusiva utilizada para identificar la operación. El ID debe ser exclusivo entre todas las operaciones descritas en la API.
    • En desuso: declara esta operación como en desuso. Los consumidores deben abstenerse de utilizar la operación declarada.
  6. Si está creando una operación de vía de acceso, pulse Crear.
  7. Haga clic en Guardar cuando haya terminado.