DataWorks:Registrar um service de API externo

Registrar uma API

Se você ainda não tem uma API, crie uma primeiro. Para mais informações, consulte Criar uma API a partir de uma fonte de dados (API Gateway).

1. Na página Service Development, clique em e escolha Create API > Register API.

   Alternativamente, abra o processo de negócios relevante, clique com o botão direito em API e selecione Create API > Register API.

2. Na caixa de diálogo Register API, configure os parâmetros.

   Parâmetro	Descrição
   Location	Diretório onde a API é armazenada. Importante Recomendamos selecionar a pasta de destino primeiro. Se não houver pasta disponível, crie um processo de negócios antes.
   API Name	Nome exclusivo da API no grupo do API Gateway e no workspace.
   APIPath	Caminho da API, como /user.
   Protocol	Protocolos suportados: HTTP e HTTPS. Para chamar a API via HTTPS, publique-a no API Gateway, vincule um nome de domínio dedicado no console do API Gateway e faça upload de um certificado SSL. Para mais detalhes, consulte Ativar HTTPS.
   Request Method	Métodos suportados: GET, POST, PUT e DELETE.
   Response Type	Tipos suportados: JSON e XML.
   Visible Scope	As opções disponíveis são Work space e Private. Work space: A API fica visível para todos os membros do workspace atual. Private: A API é visível apenas para o proprietário. APIs privadas não suportam autorização. Nota Se o escopo de visibilidade for definido como privado, somente você verá a API na árvore de diretórios; outros membros do workspace não terão acesso a ela.
   Tag	Selecione uma tag na lista Tag.
   Description	Descrição da API, com limite de 2.000 caracteres.

Configurar a API

1. Clique duas vezes na API registrada para abrir sua página de configuração. Na seção Define Backend Service, configure os seguintes parâmetros.

   Parâmetro	Descrição
   Host	Host do service de back-end. O valor deve começar com http:// ou https:// e não deve conter um caminho. Nota Por exemplo, se a URL do seu service for http://xxx-cn-xxx.alicloudapi.com/user/info, defina o host do service de back-end como http://xxx-cn-xxx.alicloudapi.com. Configure este parâmetro com base na URL real do seu service.
   Path	Caminho do service de back-end. É possível incluir parâmetros de caminho entre colchetes ([]), como /user/[userid]. Após configurar parâmetros no caminho, o sistema os adiciona automaticamente à lista de parâmetros de solicitação e define sua posição como PATH. Nota Por exemplo, se a URL do seu service for http://xxx-cn-xxx.alicloudapi.com/user/info, defina o caminho do service de back-end como /user/info. Configure este parâmetro com base na URL real do seu service.
   Back-end Service Timeout	Tempo limite do service de back-end.

2. Na seção Define Request Parameters, configure os parâmetros abaixo.

   A tabela Request Parameters inclui colunas como Nome do Parâmetro, Posição do Parâmetro, Tipo do Parâmetro, Obrigatório, Valor de Exemplo, Valor Padrão e Descrição. Já a tabela Constant Parameters contém Nome do Parâmetro, Posição do Parâmetro, Tipo do Parâmetro, Valor Padrão e Descrição.

   Parâmetro	Descrição
   Request Parameters	Clique em Add para configurar os parâmetros de solicitação da API. A Parameter Position pode ser QUERY, HEAD, PATH ou Body. As posições disponíveis dependem do método de solicitação escolhido. Selecione a posição conforme sua necessidade.
   Constant Parameters	Parâmetros constantes possuem valores fixos e ficam ocultos para os chamadores da API. O service de back-end sempre recebe esses parâmetros com os valores configurados.
   Request body definition	Esta seção aparece apenas quando o método de solicitação é POST ou PUT. Forneça um exemplo de corpo de solicitação em formato JSON ou XML para demonstrar aos chamadores como estruturar a requisição.

3. Na seção Define Response Content, forneça um Correct Response Example e um Error Response Example. Esses exemplos ajudam os chamadores a entender o formato da resposta e a escrever o código de parsing.

4. Na seção Error Code Definition, defina o Error Code, a Error message e a Solution para possíveis erros. Isso auxilia os chamadores a diagnosticar e resolver problemas de forma independente.

5. Clique em na barra de ferramentas superior para salvar a API.