DataWorks:Registrar um serviço de API externo

Registrar uma API

Se você ainda não tem uma API, crie-a 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 selecione 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 fica armazenada. Importante Selecione primeiro a pasta de destino. Se não houver nenhuma 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 compatíveis: 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 carregue um certificado SSL. Para mais informações, consulte Ativar HTTPS.
   Request Method	Métodos compatíveis: GET, POST, PUT e DELETE.
   Response Type	Tipos compatíveis: 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 oferecem suporte a autorização. Nota Se você definir o escopo de visibilidade como privado, somente você verá a API na árvore de diretórios. Os demais 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 serviço 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 serviço for http://xxx-cn-xxx.alicloudapi.com/user/info, defina o host do serviço de back-end como http://xxx-cn-xxx.alicloudapi.com. Configure esse parâmetro com base na URL real do seu serviço.
   Path	Caminho do serviço de back-end. Inclua parâmetros de caminho entre colchetes ([]), como /user/[userid]. Após a configuração dos parâmetros no caminho, o sistema os adiciona automaticamente à lista de parâmetros de solicitação e define a posição do parâmetro como PATH. Nota Por exemplo, se a URL do seu serviço for http://xxx-cn-xxx.alicloudapi.com/user/info, defina o caminho do serviço de back-end como /user/info. Configure esse parâmetro com base na URL real do seu serviço.
   Back-end Service Timeout	Tempo limite do serviço de back-end.

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

   

   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 selecionado. Escolha a posição conforme sua necessidade.
   Constant Parameters	Parâmetros constantes possuem valores fixos e ficam ocultos para os chamadores da API. Os chamadores não precisam transmitir esses parâmetros, mas o serviço de back-end sempre os recebe 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 mostrar 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 da API a entender o formato da resposta e a escrever o código de análise.

4. Na seção Error Code Definition, defina o Error Code, a Error message e a Solution para possíveis erros. Essas informações auxiliam os chamadores da API a diagnosticar e resolver problemas de forma independente.

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