Importar uma API OData

APLICA-SE A: Todas as camadas de gerenciamento de API

Este artigo mostra como importar um serviço compatível com OData como uma API no Gerenciamento de API.

Neste artigo, vai aprender a:

Pré-requisitos

• Uma instância de gerenciamento de API. Se você ainda não tiver uma, conclua o seguinte início rápido: Criar uma instância de Gerenciamento de API do Azure.

• Um serviço exposto como OData v2 ou v4.

Vá para a sua instância de Gestão de API

1. No portal do Azure, procure e selecione serviços de Gerenciamento de API.

   

2. Na página Serviços de Gerenciamento de API, selecione sua instância de Gerenciamento de API.

   

Importar metadados OData

1. No menu à esquerda, selecione APIs>+ Add API.

2. Em Criar a partir da definição, selecione OData.

   

3. Insira as configurações da API. Você pode atualizar suas configurações mais tarde, indo para a guia Configurações da API.

   1. Na especificação OData, insira uma URL para um ponto de extremidade de metadados OData, normalmente a URL para a raiz do serviço, acrescentada com /$metadata. Como alternativa, selecione um arquivo OData XML local para importar.

   2. Insira as configurações restantes para configurar sua API. Essas configurações são explicadas no tutorial Importar e publicar sua primeira API .

4. Selecione Criar.

   A API é adicionada à lista de APIs . Os conjuntos de entidades e funções que são expostos na descrição de metadados OData aparecem na guia Conjuntos de entidades e funções da API.

   

Atualizar o esquema OData

Você pode acessar um editor no portal para visualizar o esquema OData da sua API. Se a API for alterada, você também poderá atualizar o esquema no Gerenciamento de API a partir de um arquivo ou de um ponto de extremidade de serviço OData.

1. No portal, navegue até sua instância de Gerenciamento de API.

2. No menu à esquerda, selecione APIs> sua API OData.

3. Na guia Conjuntos de entidades e funções, selecione o menu de contexto (...) ao lado de um conjunto de entidades ou função e selecione Editar.

   

4. Analise o esquema. Se quiser atualizá-lo, selecione Atualizar do arquivo ou Atualizar esquema do ponto de extremidade.

   

Teste sua API OData

1. No menu à esquerda, selecione APIs> sua API OData.

2. Na guia Conjuntos de entidades e funções, selecione o menu de contexto (...) ao lado de um conjunto de entidades ou função e selecione Testar.

   

3. No console de teste, insira parâmetros de modelo, parâmetros de consulta e cabeçalhos para seu teste e selecione Testar. Saiba mais sobre como testar uma API no portal.

Proteja sua API OData

Proteja sua API OData aplicando políticas de autenticação e autorização existentes e uma política de validação OData para proteger contra ataques por meio de solicitações de API OData.

Anexar outras APIs

Você pode compor uma API de APIs expostas por diferentes serviços, incluindo:

• Uma especificação OpenAPI
• UMA API SOAP
• Uma API GraphQL
• Um Aplicativo Web hospedado no Serviço de Aplicativo do Azure
• Aplicação de Função do Azure
• Azure Logic Apps
• Azure Service Fabric

Anexe uma API diferente à sua API existente usando as etapas a seguir.

1. Aceda à sua instância de API Management do Azure no portal do Azure.

   

2. Selecione APIs na página Visão geral ou no menu à esquerda.

   

3. Clique em ... junto à API à qual quer anexar outra API.

4. Selecione Importar no menu pendente.

   

5. Selecione um serviço a partir do qual quer importar uma API.

   

Tópicos relacionados

• Limitações de importação de API
• Importar uma especificação de OpenAPI
• Importar uma API SOAP
• Importar uma API de SOAP e converter em REST
• Importar uma API do Serviço de Aplicativo
• Importar uma API de aplicativo de contêiner
• Importar uma API WebSocket
• Importar uma GraphQL API
• Importar um esquema de GraphQL e configurar resoluções de campos
• Importar uma Aplicação de Função do Azure
• Importar uma Aplicação Lógica do Azure
• Importar um serviço do Service Fabric
• Importar uma API OData
• Importar metadados do SAP OData
• Importar uma API gRPC
• Editar uma API