Een OData-API importeren

  • Artikel

VAN TOEPASSING OP: Alle API Management-lagen

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

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

Notitie

Het importeren van een OData-service als EEN API uit de metagegevensbeschrijving is in preview.

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-exemplaar

  1. Zoek en selecteer API Management-services in Azure Portal.

    API Management-services selecteren

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

    Uw API Management-exemplaar selecteren

OData-metagegevens importeren

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

  2. Selecteer OData onder Maken op basis 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 de OData-specificatie een URL in voor een OData-metagegevenseindpunt, meestal de URL naar de hoofdmap van de service, waaraan wordt toegevoegd/$metadata. U kunt ook een lokaal OData XML-bestand selecteren dat u wilt importeren.

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

  4. Selecteer Maken.

    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 in de portal.

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 in het linkermenu API's> uw OData-API.

  3. Selecteer op het tabblad Entiteitssets en functies het contextmenu (...) naast een entiteitsset of functie en selecteer Bewerken.

    Schermopname van het contextmenu voor een OData-entiteit die is ingesteld in de portal.

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

    Schermopname van schema-editor voor OData-API in de portal.

Uw OData-API testen

  1. Selecteer in het linkermenu API's> uw OData-API.

  2. Selecteer op het tabblad Entiteitssets en functies het contextmenu (...) naast een entiteitsset of functie en selecteer Testen.

    Schermopname van de optie Testen in het contextmenu voor een OData-entiteit die is ingesteld in de portal.

  3. Voer in de testconsole sjabloonparameters, queryparameters en headers voor uw test in en selecteer Testen. Meer informatie over het testen van een API in de portal.

Uw OData-API beveiligen

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

Tip

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

Andere API's toevoegen

U kunt een API opstellen van API's die beschikbaar worden gesteld door verschillende services, waaronder:

  • Een OpenAPI-specificatie
  • Een SOAP-API
  • Een GraphQL-API
  • Een web-app die wordt gehost in Azure-app Service
  • Azure Function-app
  • Azure Logic-apps
  • Azure Service Fabric

Voeg een andere API toe aan uw bestaande API met behulp van de volgende stappen.

Notitie

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

  1. Ga naar uw Azure API Management-exemplaar in de Azure-portal.

    Ga naar azure API Mgmt-exemplaar

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

    API's selecteren

  3. Selecteer het beletselsteken (... ) naast de API waaraan u een andere API wilt toevoegen.

  4. Selecteer Importeren in de vervolgkeuzelijst.

    Importeren selecteren

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

    Service selecteren