Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Atualizado em 2024-07-25 GMT+08:00

Criação de uma API

Cenário

Você pode expor seletivamente seus serviços configurando suas APIs no APIG.

Para criar uma API, defina as informações básicas e defina a solicitação da API, o serviço de back-end e as respostas.

O APIG usa uma arquitetura de API baseada em REST, portanto, a abertura e a chamada da API devem estar em conformidade com as especificações da API RESTful relacionadas.

Pré-requisitos

  • Você criou um grupo de APIs. Se nenhum grupo de API estiver disponível, crie um durante a criação da API.
  • Se o serviço de back-end da API for implementado em uma VPC, você criou um canal da VPC para acessar o serviço seguindo o procedimento em Criação de um canal da VPC. Você também pode criar um canal da VPC durante a criação da API.

Configuração de informações básicas

  1. Acesse o console de gerenciamento.
  2. Clique em no canto superior esquerdo e selecione uma região.
  3. Clique em no canto superior esquerdo e escolha API Gateway.
  4. Escolha um tipo de gateway no painel de navegação.

    • Shared Gateway: você pode criar e gerenciar APIs imediatamente. Você será cobrado com base no número de chamadas de API.
    • Dedicated Gateways: você pode criar e gerenciar APIs depois de comprar um gateway. Você será cobrado com base na duração de uso do gateway.

  5. No painel de navegação, escolha API Publishing > APIs.
  6. Clique em Create API e defina os parâmetros listados em Tabela 1.

    Tabela 1 Informações básicas

    Parâmetro

    Descrição

    Name

    Nome da API. É recomendável inserir um nome com base nas regras de nomenclatura para facilitar a pesquisa.

    API Group

    O grupo ao qual a API pertence.

    Se nenhum grupo de APIs estiver disponível, clique em Create API Group para criar um.

    Gateway Response

    Exibido se o APIG falhar ao processar uma solicitação de API.

    O APIG fornece um conjunto de respostas padrão e também permite que você crie respostas de gateway com códigos de status e conteúdo personalizados, na página API Groups. O conteúdo da resposta deve estar no formato JSON.

    Visibility

    Determine se a API está disponível para o público. Opções:

    • Public

    Security Authentication

    Os seguintes modos de autenticação estão disponíveis:

    • App: as solicitações para a API serão autenticadas pelo APIG.
    • IAM: as solicitações para a API serão autenticadas pelo Identity and Access Management (IAM).
    • Custom: as solicitações para a API serão autenticadas usando seu próprio sistema ou serviço de autenticação (por exemplo, um sistema de autenticação baseado em OAuth).
    • None: nenhuma autenticação será necessária.

    O método de chamada da API varia dependendo do modo de autenticação. Para obter detalhes, consulte Guia de desenvolvedor.

    A autenticação da aplicação é recomendada.

    AVISO:
    • Se você definir o modo de autenticação de uma API como IAM, qualquer usuário do APIG poderá acessar a API, o que pode resultar em cobranças excessivas se a API for bombardeada com solicitações maliciosas.
    • Se você definir o modo de autenticação de uma API como None, qualquer usuário poderá acessar a API em redes públicas, o que pode resultar em cobranças excessivas se a API for bombardeada com solicitações maliciosas.
    • Se você definir o modo de autenticação de uma API como Custom, poderá criar uma função no FunctionGraph para interconectar com seu próprio sistema ou serviço de autenticação. Este modo de autenticação não é suportado em regiões onde o FunctionGraph não está disponível.

    Simple Authentication

    Esse parâmetro está disponível somente se você definir Security Authentication como App.

    Se você selecionar autenticação de aplicação, poderá configurar se deseja ativar a autenticação simples. Na autenticação simples, o parâmetro X-Apig-AppCode é adicionado ao cabeçalho da solicitação HTTP para uma resposta rápida. O APIG verifica apenas o AppCode e o conteúdo da solicitação não precisa ser assinado.

    A autenticação simples suporta apenas solicitações HTTPS e não suporta solicitações HTTP. Para mais detalhes, consulte Adição de um AppCode para autenticação simples.

    NOTA:

    Depois de ativar a autenticação simples para uma API existente, você precisa publicar a API novamente. Para mais detalhes, consulte Publicação de uma API.

    Custom Authorizer

    Este parâmetro é obrigatório se a Security Authentication estiver definida como Custom.

    Selecione um autorizador personalizado se você definir a Security Authentication como Custom. Se nenhum autorizador personalizado estiver disponível, clique em Create Custom Authorizer para criar um.

    Tag Name

    Atributo de classificação usado para identificar rapidamente a API de outras APIs.

    Description

    Descrição da API.

  7. Clique em Next.

Definição de solicitação de API

  1. Na página Define API Request, defina os parâmetros listados em Tabela 2.

    Figura 1 Definir solicitação de API
    Tabela 2 Parâmetros para definição de solicitações de API

    Parâmetro

    Descrição

    Domain Name

    O subdomínio alocado automaticamente ao grupo de APIs.

    Protocol

    O protocolo usado para chamar a API. Opções:

    • HTTP
    • HTTPS
    • HTTP&HTTPS

    HTTPS é recomendado para transmitir dados importantes ou confidenciais.

    Path

    O caminho para solicitar a API.

    Insira um caminho no formato "/users/{userId}/projects".

    • A variável em chaves ({}) é um parâmetro de solicitação. Certifique-se de que é um segmento inteiro entre um par de barras (/). Um segmento que não é marcado por um par de barras, por exemplo, /abc{userId}, não é suportado. Se você definir o modo de correspondência como Exact match, poderá adicionar um sinal de adição (+) ao final do parâmetro de requisição, por exemplo, /users/{p+}. A variável p corresponde aos segmentos entre um ou vários pares de barras (/).
    • Certifique-se de definir os parâmetros contidos no caminho da solicitação como parâmetros de entrada.
    • O conteúdo é sensível a maiúsculas e minúsculas.

    Matching

    Opções:

    • Exact match: a API pode ser chamada apenas usando o caminho de solicitação especificado.
    • Prefix match: a API pode ser chamada usando caminhos começando com os caracteres correspondentes.

      Por exemplo, se você definir o caminho da solicitação como /test/AA e o modo de correspondência como Prefix match, a API poderá ser chamada usando /test/AA/CC, mas não poderá ser chamada usando /test/AACC.

    NOTA:
    • A correspondência exata tem precedência sobre a correspondência de prefixo. A correspondência de prefixo com um prefixo curto tem uma prioridade mais baixa.

      Por exemplo, para o caminho de solicitação /a/b/c (correspondência exata), /a (correspondência de prefixo) e /a/b (correspondência de prefixo), a ordem de correspondência é /a/b/c > /a/b > /a.

    • Se você definir o modo de correspondência como Prefix match, os caracteres do caminho de solicitação da API, excluindo o prefixo, serão transmitidos de forma transparente ao serviço de back-end.

      Por exemplo, se você definir os caminhos de solicitação de front-end e back-end de uma API como /test/ e /test2/, respectivamente, e a API for chamada usando /test/AA/CC, os caracteres AA/CC serão transmitidos de forma transparente para o serviço de back-end. A URL de solicitação recebida pelo serviço de back-end é /test2/AA/CC/.

    Method

    O método de chamada da API. As opções são GET, POST, DELETE, PUT, PATCH, HEAD, OPTIONS e ANY.

    • ANY indica que a API pode ser chamada usando qualquer método de solicitação.
    • Se você definir Method como POST, PUT, PATCH ou ANY, defina o corpo da solicitação.

    CORS

    Determine se deve ativar o compartilhamento de recursos de origem cruzada (CORS).

    O CORS permite que navegadores enviem XMLHttpRequest para servidores em outros domínios, superando a limitação de que Asynchronous JavaScript and XML (AJAX) podem ser usados apenas no mesmo domínio.

    Existem dois tipos de solicitações CORS:

    • Solicitações simples: solicitações que possuem o campo Origin no cabeçalho.
    • Solicitações não tão simples: solicitações HTTP enviadas antes da solicitação real.

    Se você ativar o CORS, precisará criar outra API que use o método OPTIONS. Para mais detalhes, consulte CORS.

  2. (Opcional) Defina os parâmetros de entrada.

    Os parâmetros de entrada são transmitidos juntamente com a solicitação quando a API é chamada.
    1. Clique em Add Input Parameter.
    2. Defina os parâmetros listados em Tabela 3.
      Tabela 3 Definição do parâmetro de entrada

      Parâmetro

      Descrição

      Name

      Nome do parâmetro de entrada. Se você definir o local do parâmetro como PATH, certifique-se de que o nome do parâmetro seja o mesmo definido no caminho da solicitação.

      NOTA:
      • O nome do parâmetro não diferencia maiúsculas de minúsculas. Não pode começar com x-apig- ou x-sdk-.
      • O nome do parâmetro não pode ser x-stage.
      • Se você definir a localização do parâmetro como HEADER, verifique se o nome do parâmetro não é Authorization ou X-Auth-Token e não contém sublinhados (_).

      Location

      Posição do parâmetro nas solicitações. As opções são PATH, HEADER e QUERY.

      NOTA:

      Se você definir o local do parâmetro como PATH, deverá incluir o parâmetro no caminho da solicitação.

      Type

      Tipo do valor do parâmetro. Opções: STRING e NUMBER.

      NOTA:

      Defina o tipo de parâmetros Boolean como STRING.

      Mandatory

      Determine se o parâmetro de entrada é necessário em cada solicitação enviada para chamar a API. Se você selecionar Yes, as solicitações de API que não contêm o parâmetro de entrada serão rejeitadas.

      Passthrough

      Determine se deseja transmitir de forma transparente o parâmetro de entrada para o serviço de back-end.

      Default Value

      O valor que será usado se nenhum valor for especificado para o parâmetro de entrada quando a API for chamada. Se o parâmetro de entrada não for especificado em uma solicitação, o APIG enviará automaticamente o valor padrão para o serviço de back-end.

      Enumerated Value

      Valor enumerado do parâmetro de entrada. Use vírgulas (,) para separar vários valores enumerados. O valor desse parâmetro de entrada pode ser apenas um dos valores enumerados.

      Minimum Length

      O comprimento mínimo do valor do parâmetro. Apenas números são permitidos.

      Maximum Length

      O comprimento máximo do valor do parâmetro. Apenas números são permitidos.

      Example

      Exemplo de valor para o parâmetro.

      Description

      Descrição do parâmetro.

    3. Clique em OK.

  3. Clique em Next.

Definição do serviço de back-end

O APIG permite que você defina várias políticas de back-end para diferentes cenários. As solicitações que atendam às condições especificadas serão encaminhadas para o back-end correspondente. Por exemplo, você pode fazer com que certas solicitações para uma API sejam encaminhadas para um back-end específico especificando o endereço IP de origem nas condições de política do back-end.

Você pode definir no máximo cinco políticas de back-end para uma API, além do back-end padrão.

  1. Defina o back-end padrão.

    As solicitações de API que não atenderem às condições de qualquer back-end serão encaminhadas para o back-end padrão.

    Na página Define Backend Request, selecione um tipo de back-end.

    Tabela 4, Tabela 5 e Tabela 6 descreva os parâmetros do serviço de back-end.

    Tabela 4 Parâmetros para definir um serviço de back-end HTTP/HTTPS

    Parâmetro

    Descrição

    Protocol

    HTTP ou HTTPS. Este protocolo deve ser o utilizado pelo serviço de back-end.

    NOTA:
    • O WebSocket é compatível com HTTP e HTTPS.
    • HTTPS é recomendado para transmitir dados importantes ou confidenciais.

    Method

    O método de chamada da API. As opções são GET, POST, DELETE, PUT, PATCH, HEAD, OPTIONS e ANY.

    ANY indica que a API pode ser chamada usando qualquer método de solicitação.

    VPC Channel

    Determine se o serviço de back-end será acessado usando um canal da VPC.

    • Se sim, selecione um canal da VPC.
      NOTA:
      • Para garantir uma verificação de integridade bem-sucedida e a disponibilidade do serviço, configure os grupos de segurança dos servidores de nuvem em cada canal da VPC para permitir o acesso de 100.125.0.0/16.
    • Se não, configure o endereço do serviço de back-end.

      Digite um endereço de back-end no formato de "endereço IP do host ou nome de domínio": "número da porta". A porta padrão (80 para HTTP e 443 para HTTPS) será usada se você não especificar uma porta.

      Portas disponíveis: 1 a 65535.

      Se você quiser usar uma variável, coloque o nome da variável em sinais numéricos (#), por exemplo, #ipaddress#. Você pode usar múltiplas variáveis, por exemplo, #ipaddress##test#.

    Host Header (if applicable)

    Esse parâmetro só estará disponível se você definir o VPC Channel como Configure.

    Defina um cabeçalho de host para solicitações a serem enviadas para servidores em nuvem associados ao canal da VPC. Por padrão, o cabeçalho do host original em cada solicitação será usado.

    Path

    O caminho de solicitação (URI) do serviço de back-end. Certifique-se de que todos os parâmetros no caminho estejam entre chaves ({}). Por exemplo, /getUserInfo/{userId}.

    Se o caminho contiver uma variável de ambiente, coloque a variável de ambiente em sinais numéricos (#), por exemplo, /#path#. Você pode usar várias variáveis de ambiente, por exemplo, /#path##request#.

    Timeout (ms)

    Tempo limite de solicitação de back-end.

    Se ocorrer um erro de tempo limite de back-end durante a depuração da API, aumente o tempo limite para localizar o motivo.

    NOTA:

    Para gateways dedicados, você pode modificar o tempo limite máximo consultando Parâmetros de configuração. O intervalo de valores é de 1 ms a 600.000 ms.

    Two-way Authentication

    Determine se deve permitir que o APIG autentique o serviço de back-end da API por meio de HTTPS. Para obter detalhes sobre como configurar o certificado para autenticação bidirecional, consulte Parâmetros de configuração.

    NOTA:

    A autenticação bidirecional está disponível apenas para gateways dedicados em determinadas regiões.

    Backend Authentication

    Determine se seu serviço de back-end precisa autenticar solicitações de API.

    Se você habilitar essa opção, selecione um autorizador personalizado para autenticação de back-end. Autorizadores personalizados são funções criadas no FunctionGraph para implementar uma lógica de autenticação ou invocar um serviço de autenticação.

    NOTA:

    A autenticação de back-end depende do FunctionGraph e só está disponível em determinadas regiões.

    Tabela 5 Parâmetros para definir um serviço de back-end do FunctionGraph

    Parâmetro

    Descrição

    FunctionURN

    Identificador da função solicitada.

    Clique em Select Function URN para especificar uma função URN.

    Version/Alias

    Selecione uma versão de função ou alias. Para obter detalhes, consulte as seções "Gerenciamento de versões" e "Gerenciamento de aliases" no Guia de usuário do FunctionGraph.

    Invocation Mode

    • Synchronous: invocação síncrona. Ao receber uma solicitação de invocação, o FunctionGraph processa imediatamente a solicitação e retorna um resultado. O cliente fecha a conexão uma vez que recebeu uma resposta do back-end.
    • Asynchronous: invocação assíncrona. Os resultados de invocação de função de solicitações de clientes não importam para os clientes. Quando recebe uma solicitação, o FunctionGraph a enfileira, retorna uma resposta e processa uma a uma no estado ocioso.

    Timeout (ms)

    Tempo limite de solicitação de back-end. Para mais detalhes, consulte Tabela 4.

    Backend Authentication

    Para obter detalhes, consulte a descrição sobre autenticação de back-end em Tabela 4.

    Tabela 6 Parâmetros para definição de um serviço de back-end Mock

    Parâmetro

    Descrição

    Status Code

    Este parâmetro só está disponível depois de actualizar o componente Shubao.

    Response

    Você pode usar o Mock para desenvolvimento, depuração e verificação de APIs. Ele permite que o APIG retorne uma resposta sem enviar a solicitação para o back-end. Isso é útil se você precisar testar APIs quando o back-end não estiver disponível.

    Backend Authentication

    Para obter detalhes, consulte a descrição sobre autenticação de back-end em Tabela 4.

    Header Parameters

    Cabeçalhos de resposta da API.

    Clique em Add Header e insira o nome do parâmetro, o valor e a descrição.

    • Se você tiver definido uma variável de ambiente no caminho de solicitação de back-end, a API não poderá ser depurada na página de depuração da API.
    • Para variáveis definidas no caminho de solicitação de back-end de uma API, as variáveis de ambiente correspondentes e seus valores devem ser configurados. Caso contrário, a API não poderá ser publicada porque não haverá valores que possam ser atribuídos às variáveis.
    • Os nomes das variáveis de ambiente diferenciam maiúsculas de minúsculas.

  2. (Opcional) Adicione uma política de back-end.

    Você pode adicionar políticas de back-end para encaminhar solicitações para diferentes serviços de back-end.

    1. Clique em Add Backend Policy.
    2. Defina parâmetros referindo-se a Tabela 7 e Tabela 4.
      Figura 2 Adição de uma política de back-end
      Tabela 7 Parâmetros de política de back-end

      Parâmetro

      Descrição

      Name

      O nome da política de back-end.

      Effective Mode

      • Any condition met: a política de back-end entra em vigor se alguma das condições da política tiver sido cumprida.
      • All conditions met: a política de back-end entra em vigor somente quando todas as condições da política forem atendidas.

      Policy Conditions

      Condições que devem ser atendidas para que a política de back-end entre em vigor. Estabeleça condições referindo-se a Tabela 8.

      Tabela 8 Condições de políticas

      Parâmetro

      Descrição

      Source

      • Endereço IP de origem
      • Parâmetro de entrada
      • Parâmetros do sistema: parâmetros de tempo de execução usados pelo APIG para processar solicitações de API
      AVISO:

      Os parâmetros de entrada (por exemplo, cabeçalhos) definidos como condições de política já devem ter sido definidos nas configurações de solicitação da API.

      Somente gateways dedicados suportam o uso de parâmetros do sistema como condições de política. Se System parameter não for exibido, entre em contato com o suporte técnico para atualizar seu gateway.

      Parameter Name

      • Ao definir Source como Input parameter, selecione um parâmetro de entrada.
      • Ao definir o Source para System parameter, selecione um parâmetro do sistema.
        • reqPath: solicitar URI, por exemplo, /a/b/c.
        • reqMethod: método de requisição, por exemplo, GET.

      Parameter Location

      A localização do parâmetro é exibida apenas se você definir Source como Input parameter.

      Condition Type

      Este parâmetro é necessário somente se você definir Source para Input parameter ou System parameter.

      • Equal: o parâmetro de solicitação deve ser igual ao valor especificado.
      • Enumerated: o parâmetro de solicitação deve ser igual a qualquer um dos valores enumerados.
      • Matching: o parâmetro de solicitação deve ser igual a qualquer valor da expressão regular.
      NOTA:

      Ao definir o Source para System parameter e selecionar um parâmetro chamado reqMethod, você pode definir o tipo de condição apenas como Equal ou Enumerated.

      Condition Value

      Defina um valor de condição de acordo com o tipo de condição.
      • Equal: insira um valor.
      • Enumerated: insira vários valores e separe-os usando vírgulas.
      • Matching: insira um intervalo, por exemplo, [0-5].

      Se você tiver definido Source para Source IP address, insira um ou mais endereços IP e separe-os usando vírgulas.

  3. (Opcional) Defina parâmetros de back-end.

    Os parâmetros de entrada da API são mapeados para os parâmetros de back-end correspondentes nas solicitações de back-end.

    1. Clique em ao lado de Backend Parameters e defina os parâmetros de back-end. Você pode usar um dos seguintes métodos:
      • Clique em Import Input Parameter. Todos os parâmetros de entrada definidos são exibidos automaticamente.
      • Clique em Add Backend Parameter Mapping e adicione os parâmetros de back-end necessários.
    2. Modifique os mapeamentos com base nos parâmetros e seus locais nas solicitações de back-end. Figura 3 destaca os parâmetros de back-end.
      Figura 3 Configurar parâmetros de back-end
      1. Se você definir o local do parâmetro como PATH, verifique se o nome do parâmetro é o mesmo que o definido no caminho da solicitação de back-end.
      2. O nome e o local de um parâmetro de entrada podem ser diferentes daqueles do parâmetro de solicitação de back-end mapeado.
        • O nome do parâmetro não diferencia maiúsculas de minúsculas. Não pode começar com x-apig- ou x-sdk-.
        • O nome do parâmetro não pode ser x-stage.
        • Se você definir o local do parâmetro como HEADER, certifique-se de que o nome do parâmetro não contenha sublinhados (_).
      3. Na figura anterior, os parâmetros test01 e test03 estão localizados nas posições de caminho e consulta das solicitações da API e seus valores serão recebidos no cabeçalho das solicitações de back-end. O test02 está localizado no cabeçalho das solicitações da API, e seu valor será recebido através do test05 no caminho das solicitações de back-end.

        Por exemplo, test01 é abc, test02 é def e test03 é xyz.

        Solicitações de API:

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

        Solicitação de back-end:

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

  4. (Opcional) Defina parâmetros constantes.

    Você pode definir parâmetros constantes para o serviço de back-end para receber constantes que são invisíveis para os chamadores da API. O APIG adiciona parâmetros constantes às posições especificadas na solicitação enviada ao serviço de back-end.

    1. Clique em ao lado de Constant Parameters.
    2. Clique em Add Constant Parameter e defina os parâmetros listados em Tabela 9.
      Figura 4 Adição de parâmetros constantes
      Tabela 9 Configuração de parâmetros constantes

      Parâmetro

      Descrição

      Name

      Nome do parâmetro constante. Se você definir o local do parâmetro como PATH, verifique se o nome do parâmetro é o mesmo que o definido no caminho da solicitação de back-end.

      NOTA:
      • O nome do parâmetro não diferencia maiúsculas de minúsculas. Não pode começar com x-apig- ou x-sdk-.
      • O nome do parâmetro não pode ser x-stage.
      • Se você definir o local do parâmetro como HEADER, certifique-se de que o nome do parâmetro não contenha sublinhados (_).

      Location

      Posição do parâmetro nas solicitações.

      As opções são PATH, QUERY e HEADER.

      Value

      Valor do parâmetro.

      Description

      Descrição do parâmetro constante.

      • O APIG envia solicitações contendo parâmetros constantes para serviços de back-end após a codificação percentual de valores de parâmetros especiais. Certifique-se de que os serviços de back-end ofereçam suporte à codificação de porcentagem. Por exemplo, o valor do parâmetro [apig] torna-se %5Bapig%5D após a codificação percentual.
      • Para valores de parâmetros de caminho, os seguintes caracteres serão codificados por porcentagem: códigos ASCII 0–31, símbolos em branco, códigos ASCII 127–255 e caracteres especial ?></%#"[\]^`{|}
      • Para valores de cadeias de consulta, os seguintes caracteres serão codificados por porcentagem: códigos ASCII 0–31, símbolos em branco, códigos ASCII 127–255 e caracteres especiais >=<+&%#"[\]^`{|}

  5. (Opcional) Defina os parâmetros do sistema.

    Os parâmetros do sistema referem-se aos parâmetros de tempo de execução relativos à execução do gateway e às autenticações de front-end e back-end. Os parâmetros são transferidos para o serviço de back-end da API para controle de acesso e autenticação personalizada.
    1. Clique em ao lado de System Parameters.
    2. Clique em Add System Parameter e defina os parâmetros listados em Tabela 10.
      Figura 5 Adição de um parâmetro do sistema
      Tabela 10 Parâmetros do sistema

      Parâmetro

      Descrição

      System Parameter Type

      • Default gateway parameter: parâmetros padrão suportados pelo APIG.
      • Frontend authentication parameter: parâmetros a serem exibidos no resultado de autenticação personalizada do front-end. Essa opção estará disponível somente se você selecionar Custom para Security Authentication na página Set Basic Information.
      • Backend authentication parameter: parâmetros a serem exibidos no resultado de autenticação personalizada do back-end. Essa opção estará disponível somente se você ativar Backend Authentication na página Define Backend Request.

      System Parameter Name

      • Se System Parameter Type for Default gateway parameter, selecione qualquer um dos seguintes parâmetros.
        • sourceIp: endereço IP de origem do chamador da API
        • stage: ambiente no qual a API é chamada
        • apiId: ID da API
        • appId: ID da aplicação que chama a API
        • requestId: ID da solicitação gerada quando a API é chamada
        • serverAddr: endereço IP do servidor de gateway
        • serverName: nome do servidor de gateway
        • handleTime: tempo de processamento da solicitação da API
        • providerAppId: ID da aplicação do provedor de API
      • Certifique-se de que os parâmetros de autenticação de front-end e back-end sejam consistentes com os parâmetros de resultado de retorno definidos para a função de autorizador personalizada correspondente.

        Para obter detalhes sobre como criar uma função de autorizador personalizada e obter parâmetros de resultado retornados, consulte Guia de desenvolvedor do API Gateway.

      Backend Parameter Name

      Nome do parâmetro de back-end para o qual o parâmetro de sistema será mapeado.

      NOTA:
      • O nome do parâmetro não diferencia maiúsculas de minúsculas. Não pode começar com x-apig- ou x-sdk-.
      • O nome do parâmetro não pode ser x-stage.
      • Se você definir o local do parâmetro como HEADER, certifique-se de que o nome do parâmetro não contenha sublinhados (_).

      Backend Parameter Location

      Posição do parâmetro back-end nas solicitações.

      Description

      Descrição do parâmetro do sistema.

  6. Clique em Next.

Definição de respostas

  1. Na página Define Response, defina os parâmetros listados em Tabela 11.

    Tabela 11 Definição de respostas

    Parâmetro

    Descrição

    Example Success Response

    Um exemplo de uma resposta retornada quando a API é chamada com sucesso.

    Example Failure Response

    Um exemplo de uma resposta retornada quando a API falha ao ser chamada.

  2. Clique em Finish.

    Depois que a API for criada, clique em seu nome na lista de APIs para exibir os detalhes.

Criação de uma API chamando uma API

Você também pode criar uma API chamando uma API fornecida pelo APIG.

Para obter detalhes, consulte Registração de uma API.

Operações de acompanhamento

Depois de criar uma API, verifique-a seguindo o procedimento em Depuração de uma API.