Creación de una API
Procedimiento:
Configuración de la configuración frontend
- En el panel de navegación, elija API Management > APIs.
- Haga clic en Create API y configure la definición frontend.
Tabla 1 Definición frontend Parámetro
Descripción
Name
Nombre de API. Se recomienda que introduzca un nombre basado en reglas de nomenclatura para facilitar la búsqueda.
API Group
De forma predeterminada, el grupo creado en Creación de un grupo de API está seleccionado.
URL
Method: Método de solicitud de la API. Establezca este parámetro en POST.
Protocol: Establezca este parámetro en HTTPS.
Nombre del subdominio: El subdominio asignado automáticamente al grupo de API creado en Creación de un grupo de API.
Path: Ruta de acceso para solicitar la API.
Gateway Response
Seleccione una respuesta que se mostrará si API Gateway no puede procesar una solicitud de API.
La respuesta del gateway predeterminado es default.
Matching
De forma predeterminada, se selecciona Exact match.
Tags
Atributo de clasificación utilizado para identificar rápidamente la API de otras API.
Descripción
Descripción de la API.
- Configure las opciones de seguridad basadas en la tabla siguiente.
Tabla 2 Definición de solicitud de API Parámetro
Descripción
Authentication Mode
Modo de autenticación de API. Establezca este parámetro en App.
Simple Authentication
Si habilita esta opción, API Gateway solo verifica el AppCode y no es necesario verificar la firma de la solicitud. Para este ejemplo, habilite la autenticación simple.
- Haga clic en Next.
Configuración de la configuración backend
- En la página Backend Configuration, establezca la información del servicio backend.
- Seleccione un tipo de servicio backend. Para este ejemplo, seleccione HTTP/HTTPS.
Tabla 3 Definición del servicio backend de HTTP/HTTPS Parámetro
Descripción
Load Balance Channel
Determine si se accederá al servicio backend mediante un canal de balance de carga. Para este ejemplo, seleccione Skip.
URL
Method: Método de solicitud de la API. Establezca este parámetro en POST.
Protocol: Establezca este parámetro en HTTP.
Backend Address: Dirección del servicio backend.
Path: Ruta del servicio backend.
Timeout
Tiempo de espera de solicitud de servicio backend. Valor predeterminado: 5000 ms.
- En la página Define Response, establezca las respuestas.
Tabla 4 Definición de respuestas Parámetro
Descripción
Example Success Response
Un ejemplo de una respuesta devuelta cuando se invoca correctamente a la API.
Example Failure Response
Un ejemplo de una respuesta devuelta cuando no se puede invocar a la API.
- Haga clic en Finish.
