Importar metadados do SAP OData como uma API

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

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

Neste artigo, você:

• Recuperar metadados OData do seu serviço SAP
• Importe metadados OData para o Gerenciamento de API, diretamente ou após a conversão para uma especificação OpenAPI
• Configuração completa da API
• Testar a API no Portal do Azure

Nota

A importação de uma API OData para o Gerenciamento de API a partir de sua descrição de metadados está em visualização. Mais informações.

Pré-requisitos

• Uma instância de gerenciamento de API existente. Crie um, caso ainda não o tenha feito.

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

• Se o back-end SAP usar um certificado autoassinado (para fins de 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 apontando para o serviço de back-end SAP.
  3. Desmarque Validar cadeia de certificados e Validar nome do certificado.

  Nota

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

Recuperar metadados OData do seu serviço SAP

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

• Use o SAP Gateway Client (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 Gerenciamento de API.

   

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

   

Importar API para 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 ou converta o XML de metadados em uma especificação OpenAPI.

Metadados OData

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.

Gorjeta

No portal, configure políticas para 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.

   A seguir está um exemplo de comando para converter 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 fins de teste com um único arquivo XML, você pode usar um conversor baseado na Web baseado na ferramenta de código aberto.
   • Com a ferramenta ou o conversor baseado na web, especificar o <endereço> IP:<porta> do seu servidor SAP OData é opcional. Como alternativa, adicione essas informações posteriormente na especificação OpenAPI gerada ou depois de importar para o Gerenciamento de API.

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

Importar e publicar API de back-end

1. No menu de navegação lateral, na seção APIs , selecione APIs.

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

   

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

4. Insira as configurações da API. Você pode definir os valores durante a criação ou configurá-los mais tarde, indo para a guia Configurações .

   • No sufixo de 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

As limitações de importação da API estão documentadas em outro artigo.

Configuração completa da API

Adicione as três operações a seguir à API que você importou.

• GET /$metadata

  Operation	Description	Configuração adicional para operação
  GET /$metadata	Permite que o Gerenciamento de API alcance o ponto de extremidade, que é necessário para a $metadata integração do cliente 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 /

  Operation	Description	Configuração adicional para operaçã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 usando o verbo GET. A troca de tokens CSRF não é abordada neste artigo. Veja um exemplo de trecho de política de Gerenciamento de API para broker token exchange.	N/A

  

• GET /

  Operation	Description	Configuração adicional para operação
  GET /	Permite a configuração da política na raiz do serviço.	Configure a seguinte política de rewrite-uri de entrada para acrescentar uma barra à direita às solicitações que são encaminhadas para a raiz do serviço: <rewrite-uri template="/" copy-unmatched-params="true" /> Esta política elimina a ambiguidade potencial de pedidos com ou sem barras à direita, que são tratados de forma diferente por alguns backends.

  

Além disso, configure 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.

Testar a API

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

2. No menu de navegação lateral, 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 chamada para verificar a GET /$metadata conectividade com o back-end SAP

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

7. Quando o teste estiver concluído, saia do console de teste.

Considerações sobre a produção

• Veja um exemplo de cenário de ponta a ponta 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 de solicitação OData validada. Consulte também trechos de política para propagação de entidade SAP e busca de um token X-CSRF.
• Para obter orientação para 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.

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