Delen via


Een OData-API importeren

TOEPASSINGSBEREIK: Alle API Management-niveaus

In dit artikel wordt beschreven hoe u een OData-compatibele service importeert als een API in API-beheer.

In dit artikel leert u het volgende:

  • Een beschrijving van OData-metagegevens importeren met behulp van Azure Portal
  • Het OData-schema beheren in de portal
  • De OData-API beveiligen

Vereisten

  • Een API Management-exemplaar. Als u nog geen exemplaar hebt, voltooit u de volgende quickstart: Een Azure API Management-exemplaar maken.

  • Een service die wordt weergegeven als OData v2 of v4.

Ga naar uw API Management-instantie

  1. Zoek en selecteer in de Azure portalde API Management-services:

    Schermopname van API Management-services in de zoekresultaten.

  2. Selecteer op de pagina API Management-services uw API Management-exemplaar:

    Schermopname van een API Management-exemplaar op de pagina API Management-services.

OData-metagegevens importeren

  1. Selecteer API's in> het linkermenu en selecteer vervolgens + API toevoegen.

  2. Selecteer OData onder Maken op grond van definitie:

    Schermopname van het maken van een API op basis van een OData-beschrijving in de portal.

  3. Voer API-instellingen in. U kunt uw instellingen later bijwerken door naar het tabblad Instellingen van de API te gaan.

    1. Voer in OData-specificatie een URL in voor een OData-metagegevenseindpunt. Deze waarde is meestal de URL van de hoofdmap van de service, aangevuld met /$metadata. U kunt ook een lokaal OData XML-bestand selecteren dat u wilt importeren.

    2. Voer aanvullende instellingen in om uw API te configureren. Deze instellingen worden uitgelegd in de zelfstudie Importeren en publiceren van uw eerste API .

  4. Selecteer Aanmaken.

    De API wordt toegevoegd aan de lijst met API's. De entiteitsets en functies die worden weergegeven in de beschrijving van de OData-metagegevens, worden weergegeven op het tabblad Entiteitensets en functies van de API.

    Schermopname van OData-entiteitssets en -functies.

Het OData-schema bijwerken

U hebt toegang tot een editor in de portal om het OData-schema van uw API weer te geven. Als de API wordt gewijzigd, kunt u het schema in API Management ook bijwerken vanuit een bestand of een OData-service-eindpunt.

  1. Navigeer in de portal naar uw API Management-exemplaar.

  2. Selecteer API's in het linkermenu en selecteer vervolgens uw OData-API.

  3. Selecteer op het tabblad Entiteitsets en functies het beletselteken (...) naast een entiteitsset of functie en selecteer vervolgens Bewerken.

    Schermopname van de locatie van de opdracht Bewerken.

  4. Controleer het schema. Als u deze wilt bijwerken, selecteert u Bijwerken uit bestand of Schema bijwerken vanaf eindpunt.

    Schermopname van de schema-editor voor een OData-API.

Uw OData-API testen

  1. Selecteer API's in het linkermenu en selecteer vervolgens uw OData-API.

  2. Selecteer op het tabblad Entiteitsets en functies het beletselteken (...) naast een entiteitsset of functie en selecteer vervolgens Testen.

    Schermopname van de opdracht Testen.

  3. Voer in de testconsole sjabloonparameters, queryparameters en headers voor uw test in en selecteer vervolgens Testen. Zie De nieuwe API testen in de portal voor meer informatie over het testen van API's in de portal.

Uw OData-API beveiligen

Beveilig uw OData-API door bestaand verificatie- en autorisatiebeleid en een OData-validatiebeleid toe te passen om te beschermen tegen aanvallen via OData-API-aanvragen.

Aanbeveling

Configureer in de portal beleidsregels voor uw OData-API op het tabblad API-beleid .

Andere API's toevoegen

U kunt een API samenstellen uit API's die worden weergegeven door verschillende services, waaronder:

  • Een OpenAPI-specificatie
  • Een SOAP-API
  • Een GraphQL-API
  • Een web-app die wordt gehost in Azure App Service
  • Azure Functions (serverloze computerdiensten van Azure)
  • Azure Logic Apps
  • Azure Service Fabric

Notitie

Wanneer u een API importeert, worden de bewerkingen toegevoegd aan uw huidige API.

Een API toevoegen aan een bestaande API:

  1. Ga naar uw Azure API Management-exemplaar in Azure Portal:

    Schermopname van de pagina API Management-services.

  2. Selecteer API's op de Overzicht pagina of selecteer API's>API's in het menu aan de linkerkant.

    Screenshot van de selectie van API's op de pagina 'Overzicht'.

  3. Selecteer het beletselteken (#A0 ... #A1) naast de API waaraan u een andere API wilt toevoegen.

  4. Selecteer Import uit het vervolgkeuzemenu.

    Schermopname van de opdracht importeren.

  5. Selecteer de service waaruit een API moet worden geïmporteerd.