Configurar o roteiro e a URL do host

  • 3 minutos

Um uso comum de modelos de política é para permitir a configuração dinâmica da API que os gatilhos de ponto de extremidade e as ações usarão no runtime. Os seguintes modelos de política estão disponíveis:

  • Definir URL do host: substitui a URL completa do host por uma criada pela política.

  • Solicitação de roteiro: roteia uma solicitação de entrada até um ponto de extremidade especificado na URL do host configurada.

Definir URL do host

Por padrão, a URL do host usada é configurada de maneira estática, semelhante a todos os gatilhos e ações no conector. Ao usar o modelo Definir a política de URL do host, você pode configurar a URL para os gatilhos e as ações individualmente. Um exemplo desse cenário seria se você tivesse ações relacionadas a ordens em uma URL (por exemplo, ordersapi.contoso.com) e ações relacionadas ao usuário em outra (por exemplo, userapi.contoso.com). Nesse cenário, você configuraria dois modelos de política, cada um selecionando as ações de ordem ou de usuário apropriadas para aplicação das novas URLs do host.

Provavelmente, o uso mais comum é permitir que os usuários forneçam a URL do host no runtime quando criarem uma nova conexão usando o conector personalizado, como mostrado anteriormente neste módulo. Neste exemplo, uma propriedade chamada hostURL foi adicionada à expressão connectionParameters e o usuário forneceu a URL completa do host no momento da conexão.

Outra forma comum de usar o modelo Definir a política de URL do host é criar parte da URL do host de maneira dinâmica e a outra parte de maneira estática. Ao usar essa abordagem, o usuário só precisa fornecer o nome da conta ou outros dados-chave que possam criar a URL completa. Um exemplo desse cenário é o conector do Azure Key Vault, no qual a URL do host é exclusiva para cada cofre. Em vez de solicitar que o usuário forneça a URL completa do cofre (https://contosokv.vault.azure.net), você pode adicionar uma propriedade de conexão chamada keyVaultName e solicitar que o usuário forneça somente essa parte da URL (neste exemplo, contosokv). O exemplo a seguir mostra como será a aparência desse modelo de política.

Captura de tela de detalhes da política com a seta apontando para o modelo de URL.

Você também pode incluir dados usando as expressões @headers, @queryParameters e @connectionParameters.

Solicitação de roteiro

Cada ação do conector personalizado tem uma URL totalmente qualificada (como https://api.contoso.com/AddInvoice) que é usada para fazer a solicitação para a API subjacente. Essa URL é proveniente da combinação do host (por exemplo, api.contoso.com) que você especifica na guia Geral e no caminho (como /AddInvoice) que provém de uma definição que você importou ou foi extraída de uma solicitação de exemplo quando você fez uma solicitação de importação de exemplo. A política Definir URL do host permite que você modifique o host e a Solicitação de roteiro permite que você modifique o caminho.

Outro cenário que você pode realizar com a política de Solicitação de roteiro tem várias ações que apontam para o mesmo caminho. Por exemplo, se você tivesse a ação Listar faturas com fromAmount como parâmetro e quisesse criar uma ação Listar faturas grandes com um valor padrão para fromAmount, receberia um erro porque ambas apontariam para o mesmo caminho: /ListInvoices. Em vez disso, você pode definir a ação Listar faturas grandes com um caminho de /ListBigInvoices, que não existe na API. Em seguida, você pode usar uma ação Solicitação de roteiro para enviar essas chamadas de ação para /ListInvoices. O exemplo a seguir mostra como será a aparência do modelo de política.

Captura de tela de detalhes da política mostrando nome, modelo, operações, novo caminho e método.

Também é possível incluir parâmetros e outras expressões que ajudam você a criar o caminho. Por exemplo, o conector de tarefas do Microsoft Outlook tem um caminho padrão nas pastas de listagem em um grupo de /v2/me/taskgroups('{group_id}')/taskfolders. Ao usar a seguinte ação Solicitação de roteiro, as solicitações serão roteadas para o novo caminho.

Captura de tela de detalhes da política mostrando nome, modelo, operações, novo caminho e método com valores diferentes.

Observe que, em {group_id}, as solicitações fizeram referência a um dos parâmetros da ação, semelhante à forma como foi feito no caminho original.

Ao usar os modelos de política Definir URL do host e Solicitação de roteiro, você tem flexibilidade para rotear solicitações até a API subjacente, conforme necessário.