Create an API and add an operation - API Gateway - Centro de documentación de Alibaba Cloud

Cloud-native API Gateway permite crear API REST dentro o fuera de una instancia, ya sea desde la consola o mediante la importación de un archivo OpenAPI. Una vez creada la API, puede agregar operaciones para definir las rutas y los métodos de solicitud.

Casos de uso

Las API se pueden crear dentro o fuera de una instancia, según su caso de uso.

Crear una API dentro de una instancia

Gestión dedicada de recursos: La API gestiona recursos o lógica interna exclusivamente dentro de una instancia específica.
Seguridad y aislamiento: Los datos o funciones requieren un aislamiento estricto y solo se pueden invocar desde dentro de la instancia.
Configuración simplificada del servicio: Limitar la configuración a una instancia específica facilita la gestión de la API.

Crear una API fuera de una instancia

Acceso compartido entre instancias: Varias instancias comparten una única definición de API.
Gestión y monitoreo centralizados: Control unificado de permisos, registros y gestión de tráfico.

Crear una API REST en la consola

Cloud-native API Gateway ofrece dos formas de crear API en la consola: dentro de una instancia y fuera de una instancia.

Fuera de una instancia

Inicie sesión en la consola de Cloud-native API Gateway.
En el panel de navegación izquierdo, haga clic en API. En la barra de menú superior, seleccione una región.
Haga clic en Create API.

En la tarjeta REST API, haga clic en Create. En el panel Create REST API, configure los parámetros y haga clic en Confirm.

Parámetro	Descripción
API Name	Introduzca un nombre para la API. El nombre debe ser único a nivel global.
Base path	La ruta base de la API. Cuando un cliente invoca una operación específica, la URL completa de la solicitud es `http(s)://{domain name}/{base path}/{operation path}`.
Version Management	Especifica si se habilita la gestión de versiones de la API. Las distintas versiones de una API son independientes; comparten el mismo nombre de API, pero pueden tener información básica y operaciones diferentes. Para acceder a una versión específica, incluya su identificador de versión en la solicitud. Si habilita Version Management, también debe configurar Usage. Nota Si establece Usage en Query, debe configurar el parámetro Add Query. Si establece Usage en Header, debe configurar el parámetro Add Header.
Usage	El identificador de versión se puede pasar en la Path, un parámetro de Query o un Header. Path: La ruta completa de la solicitud es `/{base path}/{version_number}/{operation_path}`. Query: La ruta completa de la solicitud es `/{base path}/{operation_path}`. La solicitud debe incluir el parámetro de consulta que especificó en Add Query, con su valor establecido en el número de versión. Header: La ruta completa de la solicitud es `/{base path}/{operation_path}`. La solicitud debe incluir el encabezado que especificó en Add Header, con su valor establecido en el número de versión.
Description	Introduzca una descripción para la API.
Resource Group	Seleccione el resource group de destino. Para crear uno nuevo, haga clic en Create Resource Group a la derecha.

Haga clic en Create API.

En la tarjeta REST API, haga clic en Create. En el panel Create REST API, configure los parámetros y haga clic en Confirm.

Parámetro	Descripción
API Name	Introduzca un nombre para la API. El nombre debe ser único a nivel global.
Base path	La ruta base de la API. Cuando un cliente invoca una operación específica, la URL completa de la solicitud es `http(s)://{domain name}/{base path}/{operation path}`.
Version Management	Especifica si se habilita la gestión de versiones de la API. Las distintas versiones de una API son independientes; comparten el mismo nombre de API, pero pueden tener información básica y operaciones diferentes. Para acceder a una versión específica, incluya su identificador de versión en la solicitud. Si habilita Version Management, también debe configurar el parámetro Usage. Nota Si establece Usage en Query, debe configurar el parámetro Add Query. Si establece Usage en Header, debe configurar el parámetro Add Header.
Usage	El identificador de versión se puede pasar en la Path, un parámetro de Query o un Header. Path: La ruta completa de la solicitud es `/{base path}/{version_number}/{operation_path}`. Query: La ruta completa de la solicitud es `/{base path}/{operation_path}`. La solicitud debe incluir el parámetro de consulta que especificó en Add Query, con su valor establecido en el número de versión. Header: La ruta completa de la solicitud es `/{base path}/{operation_path}`. La solicitud debe incluir el encabezado que especificó en Add Header, con su valor establecido en el número de versión.
Description	Introduzca una descripción para la API.
Resource Group	Seleccione el resource group de destino. Para crear uno nuevo, haga clic en Create Resource Group a la derecha.

Dentro de una instancia

Inicie sesión en la consola de Cloud-native API Gateway.
En el panel de navegación izquierdo, haga clic en Instances. En la barra de menú superior, seleccione una región.
En la página Instances, haga clic en el Instance ID de destino para ir a la página Overview. En el panel de navegación izquierdo, haga clic en API y luego en Create API.

En la tarjeta REST API, haga clic en Create. En el panel Create REST API, configure los parámetros y haga clic en Confirm.

Parámetro	Descripción
API Name	Introduzca un nombre para la API. El nombre debe ser único a nivel global.
Domain Name	Seleccione uno o más nombres de dominio para la API. Para crear un nuevo nombre de dominio, haga clic en Add Domain Name.
Base path	La ruta base de la API. Cuando un cliente invoca una operación específica, la URL completa de la solicitud es `http(s)://{domain name}/{base path}/{operation path}`.
Version Management	Especifica si se habilita la gestión de versiones de la API. Las distintas versiones de una API son independientes; comparten el mismo nombre de API, pero pueden tener información básica y operaciones diferentes. Para acceder a una versión específica, incluya su identificador de versión en la solicitud. Si habilita Version Management, también debe configurar Usage. Nota Si establece Usage en Query, debe configurar el parámetro Add Query. Si establece Usage en Header, debe configurar el parámetro Add Header.
Usage	El identificador de versión se puede pasar en la Path, un parámetro de Query o un Header. Path: La ruta completa de la solicitud es `/{base path}/{version_number}/{operation_path}`. Query: La ruta completa de la solicitud es `/{base path}/{operation_path}`. La solicitud debe incluir el parámetro de consulta que especificó en Add Query, con su valor establecido en el número de versión. Header: La ruta completa de la solicitud es `/{base path}/{operation_path}`. La solicitud debe incluir el encabezado que especificó en Add Header, con su valor establecido en el número de versión.
Description	Introduzca una descripción para la API.
Resource Group	Seleccione el resource group de destino. Para crear uno nuevo, haga clic en Create Resource Group a la derecha.
Scenario	Seleccione el caso de uso para esta operación. Escenario básico: Single Service. Escenarios de versión canary: By Percentage (Multi-service), By Content (Multi-service) y By Tag (Proportion-based Routing). Nota La suma de los porcentajes de tráfico de todos los servicios de destino debe ser 100%.
Backend Services	Asocie un servicio de backend desde la puerta de enlace actual o la VPC. Si no existe ningún servicio, haga clic en Create Service para crear uno. Importante Al crear un nuevo servicio, su información de puerto podría no aparecer de inmediato. Expanda la lista desplegable Service Name y haga clic en Refresh. La información se sincroniza de forma asíncrona y puede tardar un momento en aparecer.

Crear una API REST mediante la importación de OpenAPI

Puede importar un archivo OpenAPI para crear APIs dentro o fuera de una instancia.

Fuera de una instancia

Inicie sesión en la Cloud-native API Gateway console.
En el panel de navegación izquierdo, haga clic en API. En la barra de menú superior, seleccione una región.
Haga clic en Create API.

En la tarjeta REST API, haga clic en Import. En el panel Create File based on OpenAPI, configure los parámetros y haga clic en Precheck and Create.

Parámetro	Descripción
API Name	Introduzca un nombre para la API. El nombre debe ser único a nivel global.
Upload method	Puede usar un Local File o Import OSS files. Nota Los archivos para carga local e importación desde OSS deben cumplir con la especificación OpenAPI.
OpenAPI File	Seleccione un archivo local o pegue su contenido de texto. El tamaño del archivo no puede superar los 30 MB.
Region selection	Seleccione la región donde se encuentran sus recursos de OSS.
OSS bucket	Seleccione un bucket de OSS. No se admiten buckets que no tengan un atributo de región.
Version Management	Especifica si se habilita la gestión de versiones de la API. Las distintas versiones de una API son independientes; comparten el mismo nombre de API, pero pueden tener diferente información básica y operaciones. Para acceder a una versión específica, incluya su identificador de versión en la solicitud. Si habilita Version Management, también debe configurar Usage. Nota Si establece Usage en Query, debe configurar el parámetro Add Query. Si establece Usage en Header, debe configurar el parámetro Add Header.
Usage	El identificador de versión se puede pasar en Path, un parámetro Query o un Header. Path: La ruta completa de la solicitud es `/{base path}/{version_number}/{operation_path}`. Query: La ruta completa de la solicitud es `/{base path}/{operation_path}`. La solicitud debe incluir el parámetro de consulta que especificó en Add Query, con su valor establecido en el número de versión. Header: La ruta completa de la solicitud es `/{base path}/{operation_path}`. La solicitud debe incluir el encabezado que especificó en Add Header, con su valor establecido en el número de versión.
Description	Introduzca una descripción para la API.
Resource Group	Seleccione el resource group de destino. Para crear uno nuevo, haga clic en Create Resource Group a la derecha.

Dentro de una instancia

Inicie sesión en la Cloud-native API Gateway console.
En el panel de navegación izquierdo, haga clic en Instances. En la barra de menú superior, seleccione una región.
En la página Instances, haga clic en el Instance ID de destino para ir a la página Overview. En el panel de navegación izquierdo, haga clic en API y luego en Create API.

En la tarjeta REST API, haga clic en Import. En el panel Create File based on OpenAPI, configure los parámetros y haga clic en Precheck and Create.

Parámetro	Descripción
API Name	Introduzca un nombre para la API. El nombre debe ser único a nivel global.
Domain Name	Seleccione uno o más nombres de dominio para la API. Para crear un nuevo nombre de dominio, haga clic en Add Domain Name.
Upload method	Puede usar un Local File o Import OSS files. Nota Los archivos para carga local e importación desde OSS deben cumplir con la especificación OpenAPI.
OpenAPI File	Seleccione un archivo local o pegue su contenido de texto. El tamaño del archivo no puede superar los 30 MB.
Region selection	Seleccione la región donde se encuentran sus recursos de OSS.
OSS bucket	Seleccione un bucket de OSS. No se admiten buckets que no tengan un atributo de región.
Version Management	Especifica si se habilita la gestión de versiones de la API. Las distintas versiones de una API son independientes; comparten el mismo nombre de API, pero pueden tener diferente información básica y operaciones. Para acceder a una versión específica, incluya su identificador de versión en la solicitud. Si habilita Version Management, también debe configurar Usage. Nota Si establece Usage en Query, debe configurar el parámetro Add Query. Si establece Usage en Header, debe configurar el parámetro Add Header.
Usage	El identificador de versión se puede pasar en Path, un parámetro Query o un Header. Path: La ruta completa de la solicitud es `/{base path}/{version_number}/{operation_path}`. Query: La ruta completa de la solicitud es `/{base path}/{operation_path}`. La solicitud debe incluir el parámetro de consulta que especificó en Add Query, con su valor establecido en el número de versión. Header: La ruta completa de la solicitud es `/{base path}/{operation_path}`. La solicitud debe incluir el encabezado que especificó en Add Header, con su valor establecido en el número de versión.
Description	Introduzca una descripción para la API.
Resource Group	Seleccione el resource group de destino. Para crear uno nuevo, haga clic en Create Resource Group a la derecha.
Scenario	Seleccione el caso de uso para esta operación. Escenario básico: Single Service. Escenarios de versión canary: By Percentage (Multi-service), By Content (Multi-service) y By Tag (Proportion-based Routing). Nota La suma de los porcentajes de tráfico para todos los servicios de destino debe ser del 100 %.
Backend Services	Asocie un servicio de backend desde la puerta de enlace actual o la VPC. Si no existe ningún servicio, haga clic en Create Service para crear uno. Importante Cuando crea un nuevo servicio, es posible que su información de puerto no aparezca de inmediato. Expanda la lista desplegable Service Name y haga clic en Refresh. La información se sincroniza de forma asíncrona y puede tardar un momento en aparecer.

Agregar una operación

En la página de detalles de la API REST, haga clic en Add Operation.

En el panel Add Operation, configure los parámetros y haga clic en Add.

Parámetro	Descripción
Operation Name	Introduzca un nombre para la operación. El nombre debe ser único dentro de la API.
Operation Path	La ruta de solicitud para esta operación.
Method	El método HTTP para esta operación. La combinación de ruta de operación y método debe ser única dentro de la API.
Description	Introduzca una descripción para la operación.
Request Definition	Puede definir parámetros de Header, Query y path, así como un Body. Los parámetros de ruta se pueden definir en la ruta de operación en uno de los siguientes tres formatos: /books/{bookId} /books/[bookId] /books/:bookId Se recomienda utilizar el formato `{bookId}`. Nota Estas definiciones sirven únicamente para generar SDKs y documentación, y no se validan en tiempo de ejecución.
Response Definition	Define la estructura de datos de respuesta para diferentes códigos de estado. Estas definiciones se utilizan únicamente para la generación de documentación y no se validan en tiempo de ejecución.
Mock	Las configuraciones de Mock solo surten efecto cuando la API se publica en un entorno de pruebas (mock). Nota Esta función solo está disponible para APIs creadas fuera de una instancia.
Consumer Authentication	Especifica si se habilita la autenticación de consumidores. Deshabilitado de forma predeterminada. Si se habilita, debe vincular un consumer authorization a esta operación para que sea accesible.