Zelfstudie: Uw eerste API importeren en publiceren

Van toepassing op: Alle API Management-lagen

In deze zelfstudie ziet u hoe u een back-end-API voor OpenAPI-specificatie in JSON-indeling importeert in Azure API Management. In dit voorbeeld importeert u de open source Petstore-API.

Wanneer u de back-end-API in API Management importeert, wordt uw API Management-API een façade voor de back-end-API. U kunt de gevel aanpassen aan uw behoeften in API Management zonder de back-end-API te wijzigen. Zie Transform and protect your API (Uw API transformeren en beveiligen) voor meer informatie.

In deze zelfstudie leert u het volgende:

Na het importeren kunt u de API beheren in de Azure Portal.

Prerequisites

• Kennis van de terminologie van Azure API Management.
• Een Azure API Management-exemplaar maken.

Ga naar uw API Management-instantie

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

   

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

   

Een API importeren en publiceren

In deze sectie wordt uitgelegd hoe u een OpenAPI-specificatie voor een back-end-API kunt importeren en publiceren.

1. Selecteer API's in de linkernavigatiebalk van uw API Management-exemplaar onder API's.

2. Selecteer de tegel OpenAPI.

3. Selecteer Volledig in het venster Maken op basis van OpenAPI-specificatie.

4. Voer de waarden in uit de volgende tabel.

   U kunt API-waarden instellen tijdens het maken of later door naar het tabblad Instellingen te gaan.

   

   Setting	Waarde	Beschrijving
   OpenAPI-specificatie	https://petstore3.swagger.io/api/v3/openapi.json -of- https://petstore.swagger.io/v2/swagger.json	Hiermee geeft u de back-endservice die de API implementeert en de bewerkingen die de API ondersteunt. De URL van de back-endservice wordt later weergegeven als de URL van de webservice op de pagina Instellingen van de API. Na het importeren kunt u bewerkingen in de specificatie toevoegen, bewerken, wijzigen of verwijderen.
   Queryparameters opnemen in bewerkingssjablonen	Geselecteerd (standaard)	Hiermee geeft u op of vereiste queryparameters in de specificatie moeten worden geïmporteerd als sjabloonparameters in API Management.
   weergavenaam	Nadat u de URL van de OpenAPI-specificatie hebt ingevoerd, vult API Management dit veld in op basis van de JSON.	De naam wordt weergegeven in de ontwikkelaarsportal.
   Naam	Nadat u de URL van de OpenAPI-specificatie hebt ingevoerd, vult API Management dit veld in op basis van de JSON.	Een unieke naam voor de API.
   Beschrijving	Nadat u de URL van de OpenAPI-specificatie hebt ingevoerd, vult API Management dit veld in op basis van de JSON.	Een optionele beschrijving van de API.
   URL-schema	HTTPS	De protocollen die toegang hebben tot de API.
   API-URL-achtervoegsel	petstore	Het achtervoegsel dat is toegevoegd aan de basis-URL voor de API Management-service. API Management onderscheidt en routeert API's op basis van hun achtervoegsel, dus het achtervoegsel moet uniek zijn voor elke API voor een bepaalde uitgever. Meer informatie over hoe API Management aanvragen routeert.
   Tags		Tags voor het organiseren van API's om de API's te zoeken, te groeperen of te filteren.
   PRODUCTEN	Onbeperkt	Koppeling van een of meer API's. In bepaalde lagen wordt het API Management-exemplaar geleverd met twee voorbeeldproducten: Starter en Unlimited. U publiceert een API in de ontwikkelaarsportal door de API te koppelen aan een product. U kunt verschillende API's opnemen in een product en productabonnementen aanbieden aan ontwikkelaars via de ontwikkelaarsportal. Als u deze API aan een ander product wilt toevoegen, typt of selecteert u de productnaam. Herhaal deze stap om de API aan meerdere producten toe te voegen. U kunt API's ook later toevoegen aan producten op de pagina Instellingen. Zie Een product maken en publiceren voor meer informatie over producten.
   Gateways	Managed	API-gateway(s) die de API beschikbaar stellen. Dit veld is alleen beschikbaar in services in de categorie Developer en Premium. Beheerd geeft de gateway aan die ingebouwd is in de API Management-service en door Microsoft wordt gehost in Azure. Zelfhostende gateways zijn alleen beschikbaar in de servicecategorieën Premium en Developer. U kunt deze on-premises of in andere clouds implementeren. Als u geen gateways selecteert, is de API niet beschikbaar en slagen uw API-aanvragen niet.
   Versie van deze API?	Aanvinken of uitvinken	Zie Meerdere versies van uw API publiceren voor meer informatie.

5. Selecteer Maken om uw API te maken.

Zie de lijst met bekende problemen en beperkingen als u problemen hebt met het importeren van een API-definitie.

API-instellingen weergeven en wijzigen

Nadat u uw API hebt geïmporteerd, kunt u de instellingen en bewerkingen ervan bekijken en wijzigen in Azure Portal.

1. Selecteer API's in de linkernavigatiebalk van uw API Management-exemplaar onder API's.

2. Selecteer uw geïmporteerde API (bijvoorbeeld Swagger Petstore).

3. Selecteer het tabblad Ontwerpen om API-bewerkingen in de OpenAPI-specificatie weer te geven en te wijzigen, waaronder:

   • Bewerkingsgegevens zoals URL, methode en beschrijving
   • Definities van aanvragen en antwoorden
   • Beleid voor het wijzigen van aanvragen en antwoorden

4. Selecteer het tabblad Instellingen om api-configuratiedetails weer te geven en te wijzigen, waaronder:

   • Weergavenaam, naam en beschrijving
   • Url van webservice (back-endservice), URL-schema en API-URL-achtervoegsel
   • Producten, tags en versiebeheer
   • Geavanceerdere instellingen, zoals abonnementsvereisten, beveiliging en bewaking

Tijdens het doorlopen van de zelfstudies voor API Management leert u meer over het configureren van API-instellingen. U kunt deze instellingen op elk gewenst moment bijwerken om uw API-configuratie aan te passen.

De nieuwe API testen in de Azure-portal

U kunt API-bewerkingen rechtstreeks vanuit de Azure-portal aanroepen. Dit is een handige manier om de bewerkingen te bekijken en te testen. In de testconsole van de portal worden standaard API's aangeroepen met behulp van een sleutel van het ingebouwde abonnement voor alle toegang. U kunt ook API-aanroepen testen met behulp van een abonnementssleutel die is afgestemd op een product.

1. Selecteer in de linkernavigatiebalk van uw API Management-exemplaar API's>APIs>Swagger Petstore.

2. Selecteer het tabblad Testen en selecteer Vind huisdieren op status. Op de pagina wordt de statusqueryparameterweergegeven. Selecteer een van de beschikbare waarden, zoals in behandeling. U kunt hier ook queryparameters en headers toevoegen.

   In de sectie HTTP-aanvraag wordt de header Ocp-Apim-Subscription-Key automatisch voor u ingevuld, wat u kunt zien als u het pictogram 'oog' selecteert.

3. Klik op Verzenden.

   

   De back-end reageert met 200 OK en enkele gegevens.

Hoe API Management aanvragen routeert

API Management fungeert als een gateway tussen uw API-clients en uw back-endservices. Wanneer een client een aanvraag indient bij een API die wordt beheerd door API Management, volgt de routering dit patroon:

URL van clientaanvraag:
[API Management gateway URL] + [API URL suffix] + [Operation endpoint]

API Management stuurt de aanvraag door naar de back-endservice met behulp van dit patroon:

URL van de back-endservice:
[Web service URL] + [Operation endpoint]

In de volgende tabel wordt elke routeringsparameter beschreven in de context van het petstore-API-voorbeeld dat in deze zelfstudie wordt gebruikt:

Voorbeeld: Huisdieren zoeken op status

De Petstore-API gebruiken die in deze handleiding is geïmporteerd:

1. Client roept API Management aan:
   https://apim-hello-world.azure-api.net/petstore/pet/findByStatus?status=pending

   • API-managementgateway-URL: https://apim-hello-world.azure-api.net
   • API-URL-achtervoegsel: petstore
   • Bewerkingseindpunt: /pet/findByStatus

2. API Management-routes naar back-end:
   https://petstore3.swagger.io/api/v3/pet/findByStatus?status=pending

   • URL van webservice: https://petstore3.swagger.io/api/v3
   • Bewerkingseindpunt: /pet/findByStatus (hetzelfde als in de API Management-definitie)

Volgende stappen

In deze zelfstudie heeft u het volgende geleerd:

Ga verder met de volgende zelfstudie voor informatie over het maken en publiceren van een product: