Importar metadados do SAP OData como uma API

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

Este artigo descreve como importar um serviço OData usando sua descrição de metadados. O SAP Gateway Foundation é usado como exemplo.

Neste artigo, você:

• Recuperar metadados OData do seu serviço SAP
• Importe metadados OData para o Gerenciamento de API do Azure, diretamente ou depois de convertê-los em uma especificação OpenAPI
• Configuração completa da API
• Testar a API no Portal do Azure

Pré-requisitos

• Uma instância de Gestão de API. Se você não tiver uma, conclua as etapas em Criar uma instância de Gerenciamento de API usando o portal do Azure.

• Um sistema e serviço SAP que está exposto como OData v2 ou v4.

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

  1. No portal do Azure, em APIs, selecione Backends>+ Add.
  2. Adicione uma URL personalizada que aponte para o serviço de back-end SAP.
  3. Desmarque as caixas de seleção Validar cadeia de certificados e Validar nome do certificado .

  Nota

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

Recuperar metadados OData do seu serviço SAP

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

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

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

1. No Portal do Azure , procure e selecione Serviços de Gestão de API:

   

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

   

Importar uma API para o Gerenciamento de API

Escolha um dos seguintes métodos para importar sua API para o Gerenciamento de API:

• Importe o XML de metadados como uma API OData diretamente.
• Converta o XML de metadados em uma especificação OpenAPI.

Metadados OData

Importar metadados OData

1. No menu à esquerda, selecione APIs> APIse, em seguida, selecione + Adicionar 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 de um endpoint de metadados OData. Esse valor normalmente é a URL para a raiz do serviço, anexada com /$metadata. Como alternativa, selecione um arquivo OData XML local para importar.

   2. Insira configurações adicionais 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 e, em seguida, selecione sua API OData.

3. No separador Conjuntos de entidades e funções , selecione as reticências (...) junto a um conjunto de entidades ou função e, em seguida, selecione Editar.

   

4. Analise o esquema. Se quiser atualizar, selecione Atualizar do ficheiro ou Atualizar esquema do endpoint.

   

Teste sua API OData

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

2. No separador Conjuntos de entidades e funções , selecione as reticências (...) junto a um conjunto de entidades ou função e, em seguida, selecione Testar.

   

3. No console de teste, insira parâmetros de modelo, parâmetros de consulta e cabeçalhos para o teste e selecione Testar. Para obter mais informações sobre como testar APIs no portal, consulte Testar a nova 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.

Gorjeta

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

Especificação de OpenAPI

Converter metadados OData para OpenAPI JSON

1. Converta o OData XML para o formato JSON OpenAPI. Use uma ferramenta de código aberto OASIS para OData v2 ou OData v4, dependendo do XML de metadados.

   O exemplo a seguir converte OData v2 XML para o serviço epm_ref_apps_prod_man_srvde teste:

   odata-openapi -p --basePath '/sap/opu/odata/sap/epm_ref_apps_prod_man_srv' \
    --scheme https --host <your IP address>:<your SSL port> \
    ./epm_ref_apps_prod_man_srv.xml
   

   Nota

   • Para testar com um único arquivo XML, você pode usar um conversor baseado na Web baseado em uma ferramenta de código aberto.
   • Com a ferramenta ou o conversor baseado na web, especificar o <endereço IP>:<porta> do servidor SAP OData é opcional. Como alternativa, adicione essas informações posteriormente na especificação OpenAPI gerada ou depois de importar o arquivo para o Gerenciamento de API.

2. Salve o openapi-spec.json arquivo localmente para importação para o Gerenciamento de API.

Importar especificação OpenAPI

1. No painel de navegação esquerdo, na seção APIs , selecione APIs.

2. Em Criar uma nova definição, selecione OpenAPI:

   

3. Clique em Selecionar um arquivo e, em seguida, selecione o openapi-spec.json arquivo que você salvou localmente em uma etapa anterior.

4. Insira as configurações da API. Você pode definir esses valores ao importar a API ou configurá-los posteriormente acessando a guia Configurações .

   • Para o sufixo URL da API, recomendamos usar o mesmo caminho de URL do serviço SAP original.

   • Para obter mais informações sobre configurações de API, consulte Importar e publicar seu primeiro tutorial de API .

5. Selecione Criar.

Nota

Para obter informações sobre limitações de importação de API, consulte Restrições de importação de API e problemas conhecidos.

Conclua a configuração da API

Adicione as três operações a seguir à API importada:

• GET /$metadata

  Operação	Descrição	Configuração adicional para a operação
  GET /$metadata	Permite que a Gestão de API alcance o endpoint necessário para a integração do cliente $metadata com o servidor OData. Esta operação necessária não está incluída na especificação OpenAPI que você gerou e importou.	Adicione uma 200 OK resposta.

  

• HEAD /

  Operação	Descrição
  HEAD /	Permite que o cliente troque tokens CSRF (cross-site request forgery) com o servidor SAP quando necessário. O SAP também permite a troca de tokens CSRF por meio do verbo GET. A troca de tokens CSRF não é abordada neste artigo. Veja um exemplo de trecho de política de API para realizar troca de token.

  

• GET /

  Operação	Descrição	Configuração adicional para a operação
  GET /	Habilita a configuração de política na raiz do serviço.	Configure a seguinte política de rewrite-uri de entrada para acrescentar uma barra final às solicitações que sejam encaminhadas para a raiz do serviço: <rewrite-uri template="/" copy-unmatched-params="true" /> Esta política elimina potenciais ambiguidades entre pedidos com e sem barras à direita. Esses dois tipos de solicitações são tratados de forma diferente por alguns backends.

  

Você também precisa configurar a autenticação para seu back-end usando um método apropriado para seu ambiente. Para obter exemplos, consulte Políticas de autenticação e autorização do Gerenciamento de API.

Testa a tua API

1. Navegue até sua instância de Gerenciamento de API.

2. No painel de navegação esquerdo, na seção APIs , selecione APIs.

3. Em Todas as APIs, selecione a API importada.

4. Selecione a guia Teste para acessar o console de teste.

5. Selecione uma operação, insira os valores necessários e selecione Enviar.

   Por exemplo, teste a GET /$metadata chamada para verificar a conectividade com o back-end SAP.

6. Veja a resposta. Para solucionar problemas, rastreie a chamada.

7. Quando terminar o teste, saia do console de teste.

Considerações sobre a produção

• Veja um exemplo de cenário completo para integrar o Gerenciamento de API com um gateway SAP.
• Controle o acesso a um back-end SAP usando políticas de gerenciamento de API. Por exemplo, se a API for importada como uma API OData, use a política validate OData request. Há também trechos de política para propagação principal do SAP para SAP ECC ou S/4HANA ou SAP SuccessFactors e busca de um token X-CSRF.
• Para obter orientações sobre como implantar, gerenciar e migrar APIs em escala, consulte:
  • Implantações automatizadas de API com APIOps.
  • CI/CD para Gerenciamento de API usando modelos do Azure Resource Manager.

Conteúdo relacionado

• Limitações de importação de API
• Importar uma especificação de OpenAPI
• Importar uma API SOAP
• Importe uma API SOAP e converta-a 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 resolvedores de campos
• Importar uma API de aplicativo de função
• Importar uma API de aplicativo lógico
• Importar um serviço do Service Fabric
• Importar uma API do Azure AI Foundry
• Importar uma API OpenAI do Azure
• Importar uma API LLM
• Importar uma API OData
• Exportar uma API REST como um servidor MCP
• Expor um servidor MCP existente
• Importar uma API de agente A2A
• Importar metadados do SAP OData
• Importar uma API gRPC
• Editar uma API