DataWorks:Gerenciar APIs

Visualizar uma API

1. Faça login no console do DataWorks. Na região de destino, clique em Data Analysis and Service > DataService Studio no painel de navegação à esquerda. Selecione um workspace na lista suspensa e clique em Go to DataService Studio.

2. Na página Service Development, expanda o Workflow > API.

3. Clique com o botão direito do mouse na API desejada e selecione Details.

   Nota

   A opção Details está disponível apenas para APIs publicadas. Se a API não estiver publicada, abra a página de edição e clique em Property no painel à direita para visualizar as informações básicas.

Clonar uma API

Você pode clonar uma API para um caminho específico na árvore de diretórios:

1. Na página Service Development, expanda o Workflow > API.

2. Clique com o botão direito do mouse na API desejada e selecione Cloning.

3. Na caixa de diálogo Clone API, configure os seguintes parâmetros.

   Parâmetro	Descrição
   API Name	O nome deve ter entre 4 e 50 caracteres e pode conter caracteres chineses, letras, dígitos e sublinhados (_). Deve começar com um caractere chinês ou uma letra.
   APIPath	Caminho onde a API será armazenada, por exemplo, /user. O API Path pode conter letras, dígitos, sublinhados (_) e hifens (-). Deve começar com uma barra (/) e não pode exceder 200 caracteres.
   Description	Descrição da API clonada.
   Location	Diretório onde a API será armazenada.

4. Clique em Confirm.

Excluir uma API

No DataService Studio, você pode excluir apenas APIs não publicadas. Para excluir uma API publicada, cancele a publicação primeiro:

1. (Opcional) Cancele a publicação da API.

   Se a API não estiver publicada, pule esta etapa.

   1. Na página Service Development, clique em Service Management na parte superior para acessar a página Manage APIs.

      Por padrão, a página exibe uma lista de Published APIs. A coluna Actions de cada API oferece botões como Unpublish, Authorization, Test e More.

   2. Na aba Published APIs, localize a API desejada e clique em Unpublish na coluna Actions.

   3. Após cancelar a publicação da API, clique em Service Development na parte superior da página para retornar à página Service Development.

2. Na página Service Development, expanda o Workflow > API.

3. Clique com o botão direito do mouse na API que deseja excluir e selecione Exclua.

   Importante

   Esta operação é irreversível. Proceda com cautela.

Mover uma API

No DataService Studio, você pode mover apenas APIs não publicadas. Para mover uma API publicada, cancele a publicação primeiro:

1. (Opcional) Cancele a publicação da API.

   Se a API não estiver publicada, pule esta etapa.

   1. Na página Service Development, clique em Service Management na parte superior para acessar a página Manage APIs.

      Por padrão, a página exibe uma lista de Published APIs. A coluna Actions de cada API oferece botões como Unpublish, Authorization, Test e More.

   2. Na aba Published APIs, localize a API desejada e clique em Unpublish na coluna Actions.

   3. Após cancelar a publicação da API, clique em Service Development na parte superior da página para retornar à página Service Development.

2. Na página Service Development, expanda o Workflow > API.

3. Clique com o botão direito do mouse na API que deseja mover e selecione Move.

4. Na caixa de diálogo Move Node, selecione a Location e clique em Confirm.

5. Importante

   Mover uma API pode alterar seu grupo, o que afeta a URL do endpoint após a publicação. Tenha cautela ao mover APIs publicadas.

Operações em lote

O DataWorks permite executar operações em lote nas APIs, como modificar o grupo de recursos do DataService Studio, enviá-las e publicá-las. Isso facilita a troca eficiente de grupos de recursos e a colocação das APIs em produção.

1. Na página Service Development, clique no ícone na parte superior da árvore de diretórios à esquerda para acessar a página de operações em lote.

2. Na parte superior da página de operações em lote, filtre as APIs por critérios como Workflow e Owner.

3. Na lista filtrada, marque as caixas de seleção das APIs nas quais deseja executar operações em lote.

4. Após selecionar as APIs, escolha uma operação em lote na parte inferior da página.

   A tabela a seguir descreve a relação entre as operações em lote e os estados da API.

   Operação em lote	Não publicada e não enviada	Não publicada e enviada	Publicada e não enviada	Publicada e enviada
   Modify Service Resource Group
   Submit		Não é possível enviar uma API já enviada. Para reenviar a API, acesse a página de edição, abra a aba Version Management no painel à direita e descarte a versão enviada anteriormente.		Não é possível enviar uma API já enviada. Para reenviar a API, acesse a página de edição, abra a aba Version Management no painel à direita e descarte a versão enviada anteriormente.
   Publish	É necessário enviar a API antes de publicá-la.		É necessário enviar a API antes de publicá-la.

   Nota

   Após alterar o grupo de recursos de uma API publicada, teste, envie e publique a API novamente para que as alterações tenham efeito.

Busca de código de API

Pesquise o código de APIs criadas no modo de script dentro do workspace atual.

1. No painel de navegação à esquerda, clique no ícone para acessar a página de busca de código.

   O painel esquerdo da página Service Development contém vários ícones de função, incluindo Code, Table e Search. O painel principal de busca de código contém as abas API e Data Push. A barra de pesquisa permite buscar por ID, nome ou API Path. Abaixo da barra de pesquisa encontra-se a seção recolhível business process.

2. Clique no ícone à direita da caixa de pesquisa para expandir as opções de filtro.

   Insira palavras-chave como nome da API, API Path, descrição da API, nome da tabela ou nome do campo na caixa de pesquisa para encontrar APIs. Filtre também os resultados da busca por critérios como proprietário, business process e horário de modificação.

3. Visualize os resultados da busca.

   Os resultados correspondentes aos critérios de busca aparecem abaixo da barra de pesquisa e incluem as seguintes informações:

   Nota

   Os resultados da busca incluem apenas APIs publicadas.

   • Nome da API: Clique no nome de uma API para abrir o painel de configuração à direita.

   • Conteúdo do código: Exibe a palavra-chave correspondente, o número de linha e um breve contexto. Copie o código correspondente conforme necessário.

   • Informações básicas: Mostra o ID da API, o proprietário, o business process e a última hora de modificação.