Compartilhar via


Importar metadados OData do SAP como uma API

APLICA-SE A: todas as camadas do Gerenciamento de API

Este artigo mostra como importar um serviço OData usando a respectiva descrição de metadados. Neste artigo, a SAP Gateway Foundation serve como exemplo.

Neste artigo, você vai:

  • Recuperar metadados de OData do seu serviço SAP
  • Importar metadados de OData para API Management, seja diretamente ou após a conversão para uma especificação de OpenAPI
  • Concluir a configuração de API
  • Testar a API no Portal do Azure

Pré-requisitos

  • Uma instância de Gerenciamento de API existente. Crie uma, se ainda não tiver.

  • Um sistema SAP e um serviço exposto como OData v2 ou v4.

  • Se o seu back-end do SAP usar um certificado autoassinado (para fins de teste), talvez seja necessário desabilitar a verificação da cadeia de confiança para SSL. Para fazer isso, configure um back-end em sua instância do Gerenciamento de API:

    1. Na portal do Azure, em APIs, selecione back-ends>+ Adicionar.
    2. Adicione uma URL personalizada apontando para o serviço de back-end do SAP.
    3. Desmarque as opções Validar cadeia de certificados e Validar nome do certificado.

    Observação

    Para cenários de produção, use certificados apropriados para verificação de SSL de ponta a ponta.

Recuperar metadados de OData do seu serviço SAP

Recupere o XML de metadados de seu serviço SAP, usando um dos seguintes métodos. Se você planeja converter o XML de metadados em uma especificação de OpenAPI, salve o arquivo localmente.

  • Use o cliente de gateway SAP (transação /IWFND/GW_CLIENT) ou
  • Faça uma chamada HTTP direta para recuperar o XML: http://<OData server URL>:<port>/<path>/$metadata

Navegar até a instância de Gerenciamento de API

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

    Selecione Serviços de Gerenciamento de API

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

    Selecione a sua instância de Gerenciamento de API

Importar API para o API Management

Escolha um dos seguintes métodos para importar sua API para o API Management: importar o XML de metadados como uma API OData diretamente ou converter o XML de metadados em uma especificação de OpenAPI.

Importar metadados do OData

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

  2. Em Criar com base na definição, selecione OData.

    Captura de tela da criação de uma API com base em uma descrição OData no portal.

  3. Insira as configurações de API. Você pode atualizar suas configurações mais tarde acessando 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 de /$metadata. Como alternativa, selecione um arquivo XML OData local a ser importado.

    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 as funções expostas na descrição de metadados do OData são exibidos na guia Conjuntos de entidades e funções da API.

    Captura de tela dos conjuntos de entidades e das funções OData no portal.

Atualizar o esquema OData

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

  1. No portal do Azure, navegue até a instância do Gerenciamento de API.

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

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

    Captura de tela do menu de contexto de um conjunto de entidades OData definido no portal.

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

    Captura de tela do editor de esquema da API OData no portal.

Testar a API OData

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

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

    Captura de tela da opção Testar no menu de contexto de um conjunto de entidades OData definido no portal.

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

Proteger 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 protegê-la contra ataques por meio de solicitações de API OData.

Dica

No portal, configure políticas para sua API OData na guia Políticas de API .

Considerações sobre produção