Importar metadados do SAP OData como uma API

Converter metadados OData para OpenAPI JSON

1. Use o conversor Microsoft construído por cima da ferramenta open-source OASIS.

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

   oasis-converter convert epm_ref_apps_prod_man_srv.xml api.json
   

   Nota

   Para testar com um único ficheiro XML, pode usar a experiência baseada na web.

2. Guarde o ficheiroopenapi-spec.json localmente para importação na API Management.

Importar especificação OpenAPI

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

2. Em Criar a partir da definição, selecione o bloco OpenAPI :

   

3. Escolha Selecionar um ficheiro e depois selecione o ficheiroopenapi-spec.json que guardou localmente numa 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.

Você também precisa configurar a autenticação para seu back-end usando um método apropriado para seu ambiente. Para exemplos, veja Autenticação e autorização.

Testa a tua API

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

2. No menu da barra lateral, selecione APIs>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.

Importar metadados OData

1. No menu lateral, selecione APIs> APIs e depois selecione + Adicionar API.

2. Em Criar a partir da definição, selecione o tile 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 menu lateral, APIs>APIs e depois seleciona a tua 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 Editar.

   

3. Analise o esquema. Se quiser atualizá-lo, selecione Atualizar do ficheiro ou Atualizar esquema do endpoint.

   

Teste sua API OData

1. No menu lateral, APIs>APIs e depois seleciona a tua 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.