Criação de uma API
Procedimento:
Configurar configurações de front-end
- No painel de navegação, escolha API Management > APIs.
- Clique em Create API e configure a definição de front-end.
Tabela 1 Definição de front-end 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
Por padrão, o grupo criado em Criação de um grupo de API é selecionado.
URL
Method: método de solicitação da API. Defina este parâmetro como POST.
Protocol: defina este parâmetro como HTTPS.
Subdomain name: o subdomínio alocado automaticamente ao grupo de APIs criado em Criação de um grupo de API.
Path: caminho para solicitar a API.
Gateway Response
Selecione uma resposta a ser exibida se o API Gateway não conseguir processar uma solicitação de API.
A resposta de gateway padrão é default.
Matching
Por padrão, Exact match é selecionada.
Tags
Atributo de classificação usado para identificar rapidamente a API de outras APIs.
Description
Descrição da API.
- Defina as configurações de segurança com base na tabela a seguir.
Tabela 2 Definição de solicitação de API Parâmetro
Descrição
Authentication Mode
Modo de autenticação da API. Defina este parâmetro para App.
Simple Authentication
Se você ativar essa opção, o API Gateway verificará somente o AppCode e a assinatura da solicitação não precisará ser verificada. Para este exemplo, ative a autenticação simples.
- Clique em Next.
Configurar configurações de back-end
- Na página Backend Configuration, defina as informações de serviço de back-end.
- Selecione um tipo de serviço de back-end. Para este exemplo, selecione HTTP/HTTPS.
Tabela 3 Definição do serviço de back-end HTTP/HTTPS Parâmetro
Descrição
Load Balance Channel
Determine se o serviço de back-end será acessado usando um canal de balanceamento de carga. Para este exemplo, selecione Skip.
URL
Method: método de solicitação da API. Defina este parâmetro como POST.
Protocol: defina este parâmetro como HTTP.
Backend Address: endereço do serviço de back-end.
Path: caminho do serviço de back-end.
Timeout
Tempo limite de solicitação de serviço de back-end. Valor padrão: 5000 ms.
- Na página Define Response, defina as respostas.
Tabela 4 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.
- Clique em Finish.
