Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Actualización más reciente 2023-12-12 GMT+08:00

Creación de una API

Escenario

Puede exponer sus servicios de forma selectiva configurando sus API en API Gateway.

Para crear una API, establezca la información básica y defina la solicitud de API, el servicio de backend y las respuestas.

API Gateway utiliza una arquitectura API basada en REST, por lo que la apertura y las llamadas a la API deben cumplir con las especificaciones relacionadas con la RESTful API.

Prerrequisitos

  • Ha creado un grupo API. Si no hay ningún grupo de API disponible, cree uno durante la creación de la API.
  • Si el servicio backend de la API se implementa en una VPC, ha creado un canal de VPC para acceder al servicio siguiendo el procedimiento de Creación de un canal de VPC. También puede crear un canal de VPC durante la creación de la API.

Configuración de información básica

  1. Inicie sesión en la consola de gestión.
  2. Haga clic en en la esquina superior izquierda y seleccione una región.
  3. Haz clic en en la esquina superior izquierda y elige API Gateway.
  4. Elija un tipo de puerta de enlace en el panel de navegación.

    • Shared Gateway: puede crear y gestionar API de inmediato. Se le facturará en función del número de llamadas API.
    • Dedicated Gateways: puede crear y gestionar API después de comprar una puerta de enlace. Se le facturará en función de la duración del uso del gateway.

  5. En el panel de navegación, elija API Publishing > APIs.
  6. Haga clic en Create API y establezca los parámetros enumerados en Tabla 1.

    Tabla 1 Información básica

    Parámetro

    Descripción

    Name

    Nombre de la API. Se recomienda que introduzca un nombre basado en reglas de nomenclatura para facilitar la búsqueda.

    API Group

    El grupo al que pertenece la API.

    Si no hay ningún grupo de API disponible, haga clic en Create API Group para crear uno.

    Gateway Response

    Se muestra si API Gateway no puede procesar una solicitud de API.

    API Gateway proporciona un conjunto de respuestas predeterminadas y también le permite crear respuestas de gateway con códigos de estado y contenido personalizados, en la página API Groups. El contenido de la respuesta debe estar en formato JSON.

    Visibility

    Determine si la API está disponible para el público. Opciones:

    • Public

    Security Authentication

    Los siguientes modos de autenticación están disponibles:

    • App: las solicitudes para la API serán autenticadas por API Gateway.
    • IAM: las solicitudes para la API serán autenticadas por Identity and Access Management (IAM).
    • Custom: las solicitudes de la API se autenticarán mediante su propio sistema o servicio de autenticación (por ejemplo, un sistema de autenticación basado en OAuth).
    • None: No se requiere autenticación.

    El método de llamada a la API varía según el modo de autenticación. Para obtener más información, consulte Guía para desarrolladores.

    Se recomienda la autenticación de la aplicación.

    AVISO:
    • Si estableces el modo de autenticación de una API en IAM, cualquier usuario de API Gateway puede acceder a la API, lo que puede resultar en cargos excesivos si la API se bombardea con solicitudes maliciosas.
    • Si estableces el modo de autenticación de una API en None, cualquier usuario puede acceder a la API a través de redes públicas, lo que puede resultar en cargos excesivos si la API se bombardea con solicitudes maliciosas.
    • Si configura el modo de autenticación de una API en Custom, puede crear una función de FunctionGraph para interconectarse con su propio sistema o servicio de autenticación. Este modo de autenticación no se admite en las regiones donde FunctionGraph no está disponible.

    Simple Authentication

    Este parámetro solo está disponible si establece Security Authentication en App.

    Si selecciona la autenticación de aplicaciones, puede configurar si desea habilitar la autenticación simple. En la autenticación simple, el parámetro X-Apig-AppCode se agrega al encabezado de solicitud HTTP para una respuesta rápida. API Gateway verifica solo el AppCode y el contenido de la solicitud no necesita estar firmado.

    La autenticación simple solo admite solicitudes HTTPS y no admite solicitudes HTTP. Para más detalles, consulte Adición de un AppCode para una autenticación simple.

    NOTA:

    Después de habilitar la autenticación simple para una API existente, debe publicar la API de nuevo. Para más detalles, consulte Publicación de una API.

    Custom Authorizer

    Este parámetro es obligatorio si Security Authentication está establecida en Custom.

    Seleccione un autorizador personalizado si establece Security Authentication en Custom. Si no hay ningún autorizador personalizado disponible, haga clic en Create Custom Authorizer para crear uno.

    Tag Name

    Atributo de clasificación utilizado para identificar rápidamente la API de otras API.

    Description

    Descripción de la API.

  7. Haga clic en Next.

Definición de solicitud de API

  1. En la página Define API Request, establece los parámetros enumerados en Tabla 2.

    Figura 1 Definir solicitud de API
    Tabla 2 Parámetros para definir solicitudes de API

    Parámetro

    Descripción

    Domain Name

    El subdominio asignado automáticamente al grupo API.

    Protocol

    El protocolo utilizado para llamar a la API. Opciones:

    • HTTP
    • HTTPS
    • HTTP&HTTPS

    HTTPS se recomienda para transmitir datos importantes o confidenciales.

    Path

    La ruta para solicitar la API.

    Enter a path in the format of "/users/{userId}/projects".

    • La variable en llaves ({}) es un parámetro de solicitud. Asegúrese de que es un segmento completo entre un par de barras diagonales (/). No se admite un segmento que no esté marcado por un par de barras, por ejemplo, /abc{userId}. Si establece el modo de coincidencia en Exact match, puede agregar un signo más (+) al final del parámetro de solicitud, por ejemplo, /users/{p+}. La variable p coincide con los segmentos entre uno o varios pares de barras diagonales (/).
    • Asegúrese de definir los parámetros contenidos en la ruta de acceso de solicitud como parámetros de entrada.
    • El contenido distingue entre mayúsculas y minúsculas.

    Matching

    Opciones:

    • Exact match: La API solo se puede llamar usando la ruta de solicitud especificada.
    • Prefix match: se puede llamar a la API usando rutas que comienzan con los caracteres coincidentes.

      Por ejemplo, si establece la ruta de solicitud en /test/AA y el modo de coincidencia en Prefix match, se puede llamar a la API usando /test/AA/CC pero no se puede llamar usando /test/AACC.

    NOTA:
    • La coincidencia exacta tiene prioridad sobre la coincidencia de prefijo. La coincidencia de prefijo con un prefijo corto tiene una prioridad más baja.

      Por ejemplo, para la ruta de acceso de solicitud /a/b/c (coincidencia exacta), /a (coincidencia de prefijo) y /a/b (coincidencia de prefijo), el orden de coincidencia es /a/b/c > /a/b > /a.

    • Si establece el modo de coincidencia en Prefix match, los caracteres de la ruta de solicitud de API que excluye el prefijo se transmiten de forma transparente al servicio de backend.

      Por ejemplo, si define las rutas de solicitud frontend y backend de una API como /test/ y /test2/, respectivamente, y se llama a la API usando /test/AA/CC, los caracteres AA/CC se transmitirán de forma transparente al servicio backend. La URL de solicitud recibida por el servicio backend es /test2/AA/CC/.

    Method

    El método de llamada a la API. Las opciones son GET, POST, DELETE, PUT, PATCH, HEAD, OPTIONS, y ANY.

    • ANY indica que se puede llamar a la API usando cualquier método de solicitud.
    • Si establece Method en POST, PUT, PATCH, o ANY, establezca el cuerpo de la solicitud.

    CORS

    Determine si desea habilitar el uso compartido de recursos entre orígenes (CORS).

    CORS permite que los navegadores envíen XMLHttpRequest a servidores de otros dominios, superando la limitación de que los JavaScript asíncronos y XML (AJAX) solo pueden usarse dentro del mismo dominio.

    Hay dos tipos de solicitudes CORS:

    • Solicitudes simples: solicitudes que tienen el campo Origin en el encabezado.
    • Solicitudes no tan simples: solicitudes HTTP enviadas antes de la solicitud real.

    Si habilita CORS, necesita crear otra API que use el método OPTIONS. Para más detalles, consulte CORS.

  2. (Opcional) Establecer parámetros de entrada.

    Los parámetros de entrada se transmiten junto con la solicitud cuando se llama a la API.
    1. Haga clic en Add Input Parameter.
    2. Establezca los parámetros enumerados en Tabla 3.
      Tabla 3 Definición del parámetro de entrada

      Parámetro

      Descripción

      Name

      Nombre del parámetro de entrada. Si establece la ubicación del parámetro en PATH, asegúrese de que el nombre del parámetro es el mismo que el definido en la ruta de acceso de la solicitud.

      NOTA:
      • El nombre del parámetro no distingue entre mayúsculas y minúsculas. No puede comenzar con x-apig- o x-sdk-.
      • El nombre del parámetro no puede ser x-stage.
      • Si establece la ubicación del parámetro en HEADER, asegúrese de que el nombre del parámetro no sea Authorization o X-Auth-Token y no contenga guiones bajos (_).

      Location

      Posición del parámetro en las solicitudes. Las opciones son PATH, HEADER, y QUERY.

      NOTA:

      Si establece la ubicación del parámetro en PATH, debe incluir el parámetro en la ruta de acceso de solicitud.

      Type

      Tipo del valor del parámetro. Opciones: STRING y NUMBER.

      NOTA:

      Establezca el tipo de parámetros booleanos en STRING.

      Mandatory

      Determine si el parámetro de entrada es necesario en cada solicitud enviada para llamar a la API. Si selecciona Yes, se rechazarán las solicitudes de API que no contengan el parámetro de entrada.

      Passthrough

      Determine si desea transmitir de forma transparente el parámetro de entrada al servicio de backend.

      Default Value

      El valor que se utilizará si no se especifica ningún valor para el parámetro de entrada cuando se llama a la API. Si el parámetro de entrada no se especifica en una solicitud, API Gateway enviará automáticamente el valor predeterminado al servicio de backend.

      Enumerated Value

      Valor enumerado del parámetro de entrada. Utilice comas (,) para separar varios valores enumerados. El valor de este parámetro de entrada solo puede ser uno de los valores enumerados.

      Minimum Length

      La longitud mínima del valor del parámetro. Solo se permiten números.

      Maximum Length

      La longitud máxima del valor del parámetro. Solo se permiten números.

      Example

      Ejemplo de valor para el parámetro.

      Description

      Descripción del parámetro.

    3. Haga clic en OK.

  3. Haga clic en Next.

Definición del servicio de backend

API Gateway le permite definir varias políticas de backend para diferentes escenarios. Las solicitudes que cumplan con las condiciones especificadas se enviarán al backend correspondiente. Por ejemplo, puede hacer que ciertas solicitudes a una API se reenvíen a un backend específico especificando la dirección IP de origen en las condiciones de la política del backend.

Puede definir un máximo de cinco políticas de backend para una API además del backend predeterminado.

  1. Defina el backend predeterminado.

    Las solicitudes de API que no cumplan las condiciones de ningún backend se reenviarán al backend predeterminado.

    En la página Define Backend Request, seleccione un tipo de backend.

    Tabla 4, Tabla 5, y Tabla 6 describa los parámetros del servicio backend.

    Tabla 4 Parámetros para definir un servicio backend HTTP/HTTPS

    Parámetro

    Descripción

    Protocol

    HTTP o HTTPS. Este protocolo debe ser el utilizado por el servicio backend.

    NOTA:
    • WebSocket es compatible con HTTP y HTTPS.
    • HTTPS se recomienda para transmitir datos importantes o confidenciales.

    Method

    El método de llamada a la API. Las opciones son GET, POST, DELETE, PUT, PATCH, HEAD, OPTIONS, y ANY.

    ANY indica que se puede llamar a la API usando cualquier método de solicitud.

    VPC Channel

    Determine si se accederá al servicio backend mediante un canal VPC.

    • En caso afirmativo, seleccione un canal de VPC.
      NOTA:
      • Para garantizar una comprobación del estado y la disponibilidad del servicio con éxito, configure los grupos de seguridad de los servidores en la nube en cada canal de VPC para permitir el acceso desde 100.125.0.0/16.
    • Si no, configure la dirección del servicio de backend.

      Introduzca una dirección de back-end en el formato de "dirección IP del host o nombre de dominio":"número de puerto". El puerto predeterminado (80 para HTTP y 443 para HTTPS) se usará si no especifica un puerto.

      Puertos disponibles: 1 a 65535.

      Si desea utilizar una variable, incluya el nombre de la variable en signos numéricos (#), por ejemplo, #ipaddress#. Puede usar varias variables, por ejemplo, #ipaddress##test#.

    Host Header (if applicable)

    Este parámetro sólo está disponible si establece VPC Channel en Configure.

    Defina un encabezado de host para las solicitudes que se enviarán a los servidores en la nube asociados con el canal de VPC. De forma predeterminada, se utilizará el encabezado del host original en cada solicitud.

    Path

    La ruta de solicitud (URI) del servicio backend. Asegúrese de que todos los parámetros de la ruta estén encerrados entre llaves ({}). Por ejemplo, /getUserInfo/{userId}.

    Si la ruta contiene una variable de entorno, incluya la variable de entorno en signos numéricos (#), por ejemplo, /#path#. Puede usar varias variables de entorno, por ejemplo, /#path##request#.

    Timeout (ms)

    Tiempo de espera de la solicitud de backend.

    Si se produce un error de tiempo de espera de backend durante la depuración de la API, aumente el tiempo de espera para localizar el motivo.

    NOTA:

    Para las puertas de enlace dedicadas, puede modificar el tiempo de espera máximo haciendo referencia a Parámetros de configuración. El intervalo de valores es de 1 ms a 600,000 ms.

    Two-way Authentication

    Determine si desea permitir que API Gateway autentifique el servicio de backend de API a través de HTTPS. Para obtener más información acerca de cómo configurar el certificado para la autenticación bidireccional, consulte Parámetros de configuración.

    NOTA:

    La autenticación bidireccional solo está disponible para puertas de enlace dedicadas en ciertas regiones.

    Backend Authentication

    Determine si el servicio de backend necesita autenticar las solicitudes de API.

    Si habilita esta opción, seleccione un autorizador personalizado para la autenticación de back-end. Autorizadores personalizados son funciones que se crean en el FunctionGraph para implementar una lógica de autenticación o para invocar un servicio de autenticación.

    NOTA:

    La autenticación de backend se basa en FunctionGraph y solo está disponible en ciertas regiones.

    Tabla 5 Parámetros para definir un servicio de backend de FunctionGraph

    Parámetro

    Descripción

    FunctionURN

    Identificador de la función solicitada.

    Haga clic en Select Function URN para especificar un URN de función.

    Version/Alias

    Seleccione una versión de función o alias. Para obtener más información, consulte las secciones "Administración de versiones" y "Administración de alias" en la Guía del usuario del FunctionGraph.

    Invocation Mode

    • Synchronous: invocación síncrona. Al recibir una solicitud de invocación, el FunctionGraph procesa inmediatamente la solicitud y devuelve un resultado. El cliente cierra la conexión una vez que ha recibido una respuesta del backend.
    • Asynchronous: invocación asincrónica. Los resultados de la invocación de función de las solicitudes del cliente no importan para los clientes. Cuando recibe una solicitud, el FunctionGraph pone en cola la solicitud, devuelve una respuesta y, a continuación, procesa las solicitudes una por una en estado inactivo.

    Timeout (ms)

    Tiempo de espera de la solicitud de backend. Para más detalles, consulte Tabla 4.

    Backend Authentication

    Para obtener más información, consulte la descripción sobre la autenticación de backend en Tabla 4.

    Tabla 6 Parámetros para definir un servicio de backend de Mock

    Parámetro

    Descripción

    Status Code

    Este parámetro solo está disponible después de actualizar el componente Shubao.

    Response

    Puede usar Mock para el desarrollo, depuración y verificación de API. Permite que API Gateway devuelva una respuesta sin enviar la solicitud al backend. Esto es útil si necesita probar las API cuando el backend no está disponible.

    Backend Authentication

    Para obtener más información, consulte la descripción sobre la autenticación de backend en Tabla 4.

    Header Parameters

    Encabezados de respuesta de API.

    Haga clic en Add Header, e introduzca el nombre, el valor y la descripción del parámetro.

    • Si ha definido una variable de entorno en la ruta de solicitud de backend, la API no se puede depurar en la página de depuración de API.
    • Para las variables definidas en la ruta de solicitud de backend de una API, se deben configurar las variables de entorno correspondientes y sus valores. De lo contrario, la API no se puede publicar porque no habrá valores que se puedan asignar a las variables.
    • Los nombres de las variables de entorno distinguen entre mayúsculas y minúsculas.

  2. (Opcional) Agregue una política de backend.

    Puede agregar políticas de backend para reenviar solicitudes a diferentes servicios de backend.

    1. Haga clic en Add Backend Policy.
    2. Establezca los parámetros haciendo referencia a Tabla 7 y Tabla 4.
      Figura 2 Adición de una política de backend
      Tabla 7 Parámetros de política de backend

      Parámetro

      Descripción

      Name

      Nombre de la política de backend.

      Effective Mode

      • Any condition met: La política de backend entra en vigor si se cumple alguna de las condiciones de la política.
      • All conditions met: La política de backend solo entra en vigor cuando se cumplen todas las condiciones de la política.

      Policy Conditions

      Condiciones que deben cumplirse para que la política de backend entre en vigor. Establezca las condiciones haciendo referencia a Tabla 8.

      Tabla 8 Condiciones de la política

      Parámetro

      Descripción

      Source

      • Dirección IP de origen
      • Parámetro de entrada
      • Parámetro del sistema: parámetros de tiempo de ejecución utilizados por API Gateway para procesar solicitudes de API
      AVISO:

      Los parámetros de entrada (por ejemplo, encabezados) definidos como condiciones de política deben haberse definido ya en la configuración de solicitud de API.

      Solo gateways dedicadas admiten el uso de parámetros del sistema como condiciones de política. Si no se muestra System parameter, póngase en contacto con el soporte técnico para actualizar su gateway.

      Parameter Name

      • Cuando establezca Source en Input parameter, seleccione un parámetro de entrada.
      • Al establecer Source en System parameter, seleccione un parámetro del sistema.
        • reqPath: Solicitar URI, por ejemplo, /a/b/c.
        • reqMethod: Método de solicitud, por ejemplo, GET.

      Parameter Location

      La ubicación del parámetro sólo se muestra si se establece el parámetro Source en Input parameter.

      Condition Type

      Este parámetro sólo es necesario si establece Source en Input parameter o System parameter.

      • Equal: el parámetro de solicitud debe ser igual al valor especificado.
      • Enumerated: el parámetro request debe ser igual a cualquiera de los valores enumerados.
      • Matching: el parámetro de solicitud debe ser igual a cualquier valor de la expresión regular.
      NOTA:

      Cuando establece el parámetro Source en System parameter y selecciona un parámetro denominado reqMethod, puede establecer el tipo de condición sólo en Equal o Enumerated.

      Condition Value

      Establezca un valor de condición según el tipo de condición.
      • Equal: introduzca un valor.
      • Enumerated: Introduzca varios valores y sepárelos con comas.
      • Matching: Introduzca un rango, por ejemplo, [0-5].

      Si ha establecido Source en Source IP address, introduzca una o más direcciones IP y sepárelas con comas.

  3. (Opcional) Establecer parámetros de backend.

    Los parámetros de entrada de la API se asignan a los parámetros de backend correspondientes en las solicitudes de backend.

    1. Haga clic en junto a Backend Parameters, y defina los parámetros de backend. Puede utilizar uno de los métodos siguientes:
      • Haga clic en Import Input Parameter. Todos los parámetros de entrada definidos se muestran automáticamente.
      • Haga clic en Add Backend Parameter Mapping, y agregue los parámetros de backend necesarios.
    2. Modifique las asignaciones en función de los parámetros y sus ubicaciones en las solicitudes de backend. Figura 3 resalta los parámetros del backend.
      Figura 3 Configuración de parámetros de backend
      1. Si establece la ubicación del parámetro en PATH, asegúrese de que el nombre del parámetro es el mismo que el definido en la ruta de solicitud de backend.
      2. El nombre y la ubicación de un parámetro de entrada pueden ser diferentes de los del parámetro de solicitud de back-end asignado.
        • El nombre del parámetro no distingue entre mayúsculas y minúsculas. No puede comenzar con x-apig- o x-sdk-.
        • El nombre del parámetro no puede ser x-stage.
        • Si establece la ubicación del parámetro en HEADER, asegúrese de que el nombre del parámetro no contiene guiones bajos (_).
      3. En la figura anterior, los parámetros test01 y test03 están situados en las posiciones de ruta y consulta de las solicitudes de API, y sus valores se recibirán en la cabecera de las solicitudes de backend. test02 se encuentra en el encabezado de las solicitudes de API, y su valor se recibirá a través de test05 en la ruta de las solicitudes de backend.

        Por ejemplo, test01 es abc, test02 es def, y test03 es xyz.

        Solicitud de API:

        curl -ik -H 'test02:def' -X GET https://www.example01.com/v1.0/abc?test03=xyz

        Solicitud de backend:

        curl -ik -H 'test01:abc' -H 'test03:xyz' -X GET https://www.example02.com/v1.0/def

  4. (Opcional) Establecer parámetros constantes.

    Puede definir parámetros constantes para que el servicio de backend reciba constantes que son invisibles para los que llaman a la API. API Gateway agrega parámetros constantes a las posiciones especificadas en la solicitud enviada al servicio de backend.

    1. Haga clic en junto a Constant Parameters.
    2. Haga clic en Add Constant Parameter, y defina los parámetros enumerados en Tabla 9.
      Figura 4 Adición de parámetros constantes
      Tabla 9 Definición de parámetros constantes

      Parámetro

      Descripción

      Name

      Nombre del parámetro constante. Si establece la ubicación del parámetro en PATH, asegúrese de que el nombre del parámetro es el mismo que el definido en la ruta de solicitud de backend.

      NOTA:
      • El nombre del parámetro no distingue entre mayúsculas y minúsculas. No puede comenzar con x-apig- o x-sdk-.
      • El nombre del parámetro no puede ser x-stage.
      • Si establece la ubicación del parámetro en HEADER, asegúrese de que el nombre del parámetro no contiene guiones bajos (_).

      Location

      Posición del parámetro en las solicitudes.

      Las opciones son PATH, QUERY, y HEADER.

      Value

      Valor del parámetro.

      Description

      Descripción del parámetro constante.

      • API Gateway envía solicitudes que contienen parámetros constantes a los servicios de backend después de la codificación porcentual de valores de parámetros especiales. Asegúrese de que los servicios de backend admitan la codificación porcentual. Por ejemplo, el valor del parámetro [apig] se convierte en %5Bapig%5D después de la codificación porcentual.
      • Para los valores de los parámetros de ruta, los siguientes caracteres serán codificados porcentualmente: códigos ASCII 0-31, símbolos en blanco, códigos ASCII 127-255, y caracteres especiales ?></%#"[\]^`{|}
      • Para los valores de las cadenas de consulta, los siguientes caracteres serán codificados porcentualmente: códigos ASCII 0-31, símbolos en blanco, códigos ASCII 127-255, y caracteres especiales >=<+&%#"[\]^`{|}

  5. (Opcional) Establezca los parámetros del sistema.

    Los parámetros del sistema se refieren a los parámetros de tiempo de ejecución con respecto a la ejecución de la puerta de enlace y a las autentificaciones front-end y back-end. Los parámetros se transfieren al servicio de backend de la API para el control de acceso y la autenticación personalizada.
    1. Haga clic en junto a System Parameters.
    2. Haga clic en Add System Parameter, y defina los parámetros enumerados en Tabla 10.
      Figura 5 Adición de un parámetro del sistema
      Tabla 10 Parámetros del sistema

      Parámetro

      Descripción

      System Parameter Type

      • Default gateway parameter: parámetros predeterminados compatibles con API Gateway.
      • Frontend authentication parameter: Parámetros que se mostrarán en el resultado de autenticación personalizada de frontend. Esta opción sólo está disponible si selecciona Custom para Security Authentication en la página Set Basic Information.
      • Backend authentication parameter: Parámetros que se mostrarán en el resultado de autenticación personalizada de backend. Esta opción solo está disponible si habilita Backend Authentication en la página Define Backend Request.

      System Parameter Name

      • Si System Parameter Type es Default gateway parameter, seleccione cualquiera de los siguientes parámetros.
        • sourceIp: dirección IP de origen del llamador de la API
        • stage: entorno en el que se llama la API
        • apiId: ID de la API
        • appId: ID de la aplicación que llama a la API
        • requestId: ID de solicitud generado cuando se llama a la API
        • serverAddr: dirección IP del servidor de gateway
        • serverName: nombre del servidor de gateway
        • handleTime: tiempo de procesamiento de la solicitud de API
        • providerAppId: ID de la aplicación del proveedor de API
      • Asegúrese de que los parámetros de autenticación front-end y back-end sean coherentes con los parámetros de resultado de retorno definidos para la función de autorizador personalizado correspondiente.

        Para obtener más información acerca de cómo crear una función de autorizador personalizada y obtener parámetros de resultado devueltos, consulte Guía para desarrolladores de API Gateway.

      Backend Parameter Name

      Nombre del parámetro backend al que se asignará el parámetro del sistema.

      NOTA:
      • El nombre del parámetro no distingue entre mayúsculas y minúsculas. No puede comenzar con x-apig- o x-sdk-.
      • El nombre del parámetro no puede ser x-stage.
      • Si establece la ubicación del parámetro en HEADER, asegúrese de que el nombre del parámetro no contiene guiones bajos (_).

      Backend Parameter Location

      Posición del parámetro backend en las solicitudes.

      Description

      Descripción del parámetro del sistema.

  6. Haga clic en Next.

Definición de respuestas

  1. En la página Define Response, establezca los parámetros enumerados en Tabla 11.

    Tabla 11 Definición de respuestas

    Parámetro

    Descripción

    Example Success Response

    Un ejemplo de una respuesta devuelta cuando se llama correctamente a la API.

    Example Failure Response

    Un ejemplo de una respuesta devuelta cuando no se puede llamar a la API.

  2. Haga clic en Finish.

    Una vez creada la API, haga clic en su nombre en la lista de API para ver los detalles.

Creación de una API llamando a una API

También puede crear una API llamando a una API proporcionada por API Gateway.

Para obtener más información, consulta Registro de una API.

Operaciones de seguimiento

Después de crear una API, compruébala siguiendo el procedimiento en Depuración de una API.