No DataService Studio, teste, publique e use funções como filtros para processar requisições e respostas de API.
Pré-requisitos
Certifique-se de ter criado e salvo a função. Para mais informações, consulte Gerencie functions.
Limitações
Somente o proprietário do workspace e usuários RAM com a função Workspace Administrator, Develop ou O&M podem testar funções. Para mais informações, consulte Add a workspace member and gerencie role permissions.
Etapa 1: Testar a função
-
Acesse a página Data Services.
Faça login no console do DataWorks. Na região desejada, clique em no painel de navegação à esquerda. Selecione um workspace na lista suspensa e clique em Go to DataService Studio.
Na página Service Development, localize a função em desenvolvimento na lista de funções e clique duas vezes nela.
-
Na página de edição da função, clique em Test na barra de ferramentas superior.
## --- AviatorScript --- ## $0: the default name of the input param. ## Expressions must be separated by the semicolon ";". ## Example 1: ## $0.a: Get the attribute "a" from the input param "$0". ## $0.b[index]: Get the index of the array "b" from the input param "$0". The index cannot be an expression or a variable. ## Example 2: ## Input: {"keyA":[1,2],"keyB":"value"} ## Function: $0.keyA[0]=3; $0.keyB="new_value"; return $0; ## Output: {"keyA":[3,2],"keyB":"new_value"} -
Na caixa de diálogo Function Test, insira os parâmetros e clique em Confirm.
Visualize o status da execução na aba Run Results na parte inferior. Se o teste falhar, verifique a mensagem de erro, modifique a função e teste novamente.
Etapa 2: Publicar a função
Após a aprovação da função nos testes, publique-a para torná-la disponível.
Na página Service Development, localize a função aprovada no teste na lista de funções e clique duas vezes nela.
Na barra de ferramentas superior, clique em Submission.
-
Na página de edição da função, clique em Version no painel de navegação à direita. Localize a versão com o status Can Be Published e clique em Publish na coluna Actions.
NotaApós publicar a função, clique em Version no painel de navegação à direita da página de edição para acessar o histórico de publicações. Em seguida, visualize os Version Details ou clique em Roll Back.
Etapa 3: Usar a função
Casos de uso
Como pré-filtro de API, a função pré-processa os parâmetros da requisição durante a chamada.
Como pós-filtro de API, a função processa e transforma a resposta da API.
Limitações
O pré-filtro e o pós-filtro de uma API devem usar o mesmo tipo de função. Ambos devem ser funções Aviator ou ambos funções Python.
O recurso de função Python está em atualização. Não há suporte para criar, clonar ou publicar novas funções Python no momento.
Uso como filtro de API
Na página Service Development, expanda .
Clique duas vezes na API para abrir sua página de edição.
-
No painel de navegação à direita, clique em Filter.
Marque a caixa de seleção Use Pre-filter ou Use Post-filter. O Function Type tem como padrão Aviator Function. Na lista suspensa do pré-filtro ou pós-filtro, selecione uma ou mais funções. Se adicionar várias funções, elas serão executadas na ordem de inclusão.
NotaUm filtro consiste em uma ou mais funções que pré-processam parâmetros de requisição de API ou pós-processam resultados de consulta.
Se não encontrar a função desejada na lista suspensa, verifique se ela foi publicada. Também é possível criar e publicar uma nova função. Para mais informações, consulte Publish the function.
Clique em Preview Responses Returned by API Operation para verificar a saída do filtro.