Creación de un recurso de API con una descripción de la API

• Consola
• CLIENTE
• API

• 1. Abra el menú de navegación y haga clic en Servicios para desarrolladores. En API Management, haga clic en API.
  2. Seleccione un compartimento en el que tenga permiso para trabajar.

  3. Haga clic en Crear API y, a continuación, especifique los siguientes valores para el recurso de API:

     • Nombre: nombre del recurso de API. Evite introducir información confidencial.
     • compartimento: compartimento en el que se va a crear el recurso de API.
     • Cargar archivo de descripción de API: (opcional) archivo que contiene la descripción de la API (en un lenguaje soportado) para cargar y desde el que crear la descripción de la API. El archivo puede tener un tamaño de hasta 1 MB. El archivo se analiza para confirmar que está en un lenguaje soportado y tiene un formato adecuado. Actualmente, están soportados los archivos de la especificación de OpenAPI versión 2.0 (anteriormente especificación de Swagger 2.0) y versión 3.0.
     • Mostrar opciones avanzadas: seleccione esta opción para aplicar etiquetas al recurso. Si tiene permisos para crear un recurso, también los tiene para aplicar etiquetas de formato libre a ese recurso. Si desea aplicar una etiqueta definida, debe tener permisos para utilizar el espacio de nombres de etiqueta. Para obtener más información sobre el etiquetado, consulte Etiquetas de recursos. Si no está seguro de si desea aplicar etiquetas, omita esta opción o pregunte a un administrador. Puede aplicar las etiquetas más tarde.

  4. Haga clic en Crear API para crear el recurso de API.

     Si ha cargado un archivo de descripción de la API, se crea y se valida una descripción de la API. La validación de la descripción de API puede tardar unos minutos. Mientras se está validando, la descripción de la API aparece con el estado Validando en la página Validaciones. Cuando la descripción de la API se haya validado correctamente, se producen las siguientes acciones:

     • En la página Validaciones se muestra una validación correcta.
     • En la página Descripción de API se muestra la descripción de la API creada a partir del archivo de descripción de la API.
     • En la página Especificación de despliegue de API se muestra cualquier información adicional sobre la especificación de despliegue de API por defecto creada a partir de la descripción de la API.

     Tenga en cuenta que, en lugar de crear el recurso de API inmediatamente, puede crearlo más tarde mediante Resource Manager y Terraform. Haga clic en Guardar como pila para guardar la definición de recurso como una configuración de Terraform. Para obtener más información sobre cómo guardar pilas de definiciones de recursos, consulte Creación de una pila a partir de una página de creación de recursos.

  5. Si ha esperado varios minutos para que la descripción de la API aparezca como Válida (o si la operación de validación de la descripción de la API ha fallado), siga estos pasos:

     1. Haga clic en Solicitudes de trabajo para obtener una visión general de la operación de validación de descripción de la API.
     2. Haga clic en la operación Validar API para obtener más información de la operación (incluidos los mensajes de error, los mensajes de log y el estado de los recursos asociados).
     3. Si la operación de validación de descripción de API ha fallado y no puede diagnosticar la causa del problema a partir de la información de la solicitud de trabajo, consulte Solución de problemas de gateway de API.

  6. Si no ha cargado un archivo de descripción de la API al crear el recurso de API por primera vez o si desea cargar otro archivo de descripción de la API, siga estos pasos:

     1. En la página API, seleccione Editar en el menú Acciones () del recurso de API.
     2. Proporcione detalles del archivo de descripción de la API desde el que crear la descripción de la API.

  Después de crear correctamente un recurso de API con una descripción de la API, puede desplegarlo en un gateway de API. Consulte Using the Console to Create an API Deployment from an API Resource.

• Para crear un recurso de API mediante la CLI, siga estos pasos:

  1. Configure su entorno de cliente para usar la CLI ( Configuración del entorno de cliente para utilizar la CLI para el desarrollo de gateway de API).
  2. Abra un símbolo del sistema y ejecute oci api-gateway api create para crear el recurso de API:

     oci api-gateway api create --display-name "<api-name>" --compartment-id <compartment-ocid> --content "<api-description>"

     donde:

     • <api-name> es el nombre del nuevo recurso de API. Evite introducir información confidencial.
     • <compartment-ocid> es el OCID del compartimento al que va a pertenecer el nuevo recurso de API.
     • <api-description> es opcionalmente una descripción de la API (en un lenguaje soportado). El valor especificado para <api-description> puede ser:
       • Toda la descripción de la API incluida entre comillas dobles. Dentro de la descripción, cada comilla doble se debe identificar con un carácter de barra invertida (\). Por ejemplo (y abreviado para que se pueda leer fácilmente), --content "swagger:\"2.0\",title:\"Sample API\",..."
       • Nombre y ubicación de un archivo de descripción de la API, entre comillas dobles y con el formato "$(< <path>/<filename>.yaml)". Por ejemplo, --content "$(< /users/jdoe/api.yaml)"
       La descripción se analiza para confirmar que está en un lenguaje soportado y tiene un formato adecuado. Actualmente, están soportados los archivos de la especificación de OpenAPI versión 2.0 (anteriormente especificación de Swagger 2.0) y versión 3.0.

     Por ejemplo:

     oci api-gateway api create --display-name "Hello World API Resource" --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq --content "swagger:\"2.0\",title:\"Sample API\",..."

     La respuesta al comando incluye:

     • El OCID del recurso de API.
     • El estado de ciclo de vida (por ejemplo, SUCCEEDED, FAILED).
     • El ID de la solicitud de trabajo para crear el recurso de API (los detalles de las solicitudes de trabajo están disponibles durante siete días tras la finalización, cancelación o fallo).

     Si desea que el comando espere para devolver el control hasta que se haya creado el recurso de API (o hasta que la solicitud haya fallado), incluya uno o los dos parámetros siguientes:

     • --wait-for-state SUCCEEDED
     • --wait-for-state FAILED

     Por ejemplo:

     oci api-gateway api create --display-name "Hello World API Resource" --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq --content "swagger:\"2.0\",title:\"Sample API\",..." --wait-for-state SUCCEEDED

     Tenga en cuenta que no puede utilizar el recurso de API hasta que la solicitud de trabajo lo haya creado correctamente.

  3. (Opcional) Para ver el estado de la solicitud de trabajo que está creando el recurso de API, introduzca:

     oci api-gateway work-request get --work-request-id <work-request-ocid>

  4. (Opcional) Para ver los logs de la solicitud de trabajo que está creando el recuso de API, introduzca:

     oci api-gateway work-request-log list --work-request-id <work-request-ocid>

  5. (Opcional) Si la solicitud de trabajo que está creando el recurso de API falla y quiere revisar los logs de errores, introduzca:

     oci api-gateway work-request-error --work-request-id <work-request-ocid>

  Para obtener más información sobre el uso de la CLI, consulte Interfaz de línea de comandos (CLI). Para obtener una lista completa de los indicadores y las opciones disponibles para los comandos de la CLI, consulte Ayuda de CLI.

• Ejecute la operación CreateAPI para crear un recurso de API.