Creación de una definición de OpenAPI REST

Puede crear y editar definiciones de API REST de borrador utilizando API Designer o la interfaz de usuario de API Designer en IBM® API Connect.

Para crear una definición de OpenAPI REST nueva, siga estos pasos:

1. En el panel de navegación, pulse Desarrollary, a continuación, pulse Añadir > API.
   Se visualizará la pantalla Seleccionar tipo de API.
2. Seleccione OpenAPI 2.0 o OpenAPI 3.0 según la versión de la especificación OpenAPI en la que se va a basar la API.
3. Seleccione Nuevo OpenAPI .
4. Pulse Siguiente. Especifique el resumen de API en la sección Información. Puede ajustar la API después de crearla.
   • El Título puede incluir caracteres especiales, pero debe ser corto para que se pueda visualizar fácilmente en la interfaz de usuario.
   • El Nombre se especifica automáticamente. El valor del campo Nombre es una serie única que se utiliza para identificar la API en los mandatos de CLI developer toolkit . Para ver los mandatos de CLI para gestionar borradores de API, consulte la documentación de referencia de CLI del kit de herramientas.
   • La Versión corresponde al valor de la propiedad info.version de la definición OpenAPI de la API. Se recomienda el esquema de numeración de versión de version.release.modification ; por ejemplo, 1.0.0.
   • La Vía de acceso base es el segmento de URL de la API y no incluye el nombre de host ni ningún segmento adicional para vías de acceso u operaciones. La vía de acceso base no puede incluir caracteres especiales y debe empezar por un carácter / aunque esté vacía.
   • La Descripción opcional ayuda a identificar la API.
5. Pulse Siguiente. En la sección Proteger, configure la seguridad de la API que necesita.
   • Proteger mediante ID de cliente : seleccione esta opción para exigir que una aplicación proporcione un ID de cliente (Clave de API). Esto hace que el parámetro X-IBM-Client-Id se incluya en la cabecera de solicitud para la API. Si se selecciona, puede seleccionar si se deben limitar las llamadas de API en función de la clave (por ID de cliente):
     • Limitar las llamadas de API en función de la clave - Si se selecciona, debe configurar el límite de velocidad que necesite. Los límites de velocidad controlan el número máximo de llamadas permitidas durante de un periodo de tiempo (hora, minuto, mes o día). Por ejemplo, 100 llamadas por hora.
   • CORS - Seleccione esta opción para habilitar el soporte de uso compartido de recursos de diversos orígenes (CORS) para la API. Esto permite que se pueda acceder a la API desde otro dominio.
     Nota:

     • El soporte de CORS sólo está disponible en DataPower® API Gateway.
     • Cuando CORS está habilitado, la pasarela de API ejecuta la política de preflujo cors para manejar todas las solicitudes CORS efectuadas a la API.
     • Cuando CORS está habilitado y se recibe una solicitud de verificación, sólo se realizan las siguientes acciones de API:
       • La política de preflujo cors configura las cabeceras de respuesta adecuadas.
       • Se establecen las cabeceras de respuesta.
     • Cuando se recibe una solicitud de verificación, el indicador request.attributes.isCORSPreflight se establece en true.
     • Para todas las solicitudes de verificación, las políticas de preflujo security y client-identification siempre se pasan por alto, independientemente de si CORS está habilitado.
6. Pulse Siguiente para crear la definición de API.

   El panel Resumen muestra mensajes a medida que se crea la definición y se aplican las opciones de seguridad y los límites de velocidad seleccionados.

7. Seleccione una de las siguientes opciones:
   • Para configurar la API con mayor detalle, pulse Editar API. Para obtener detalles, consulte Edición de una definición de API.
   • Si no desea seguir configurando la API en este momento, pulse el enlace Desarrollar de la indicación de ruta para volver a la página de bienvenida; a continuación, puede pasar inmediatamente a otra tarea. Para obtener detalles sobre cómo configurar la API más adelante, consulte Edición de una definición de API.