Oefening: een back-end-API maken

Voltooid

In deze oefening leert u hoe u de volgende acties uitvoert:

  • Een API Management-exemplaar (APIM) maken
  • Een API importeren
  • De back-endinstellingen configureren
  • De API testen

Vereisten

  • Een Azure-account met een actief abonnement. Als nog geen abonnement hebt, kunt u zich registreren voor een gratis abonnement op https://azure.com/free.

Aanmelden bij Azure

  1. Meld u aan bij Azure Portal en open Cloud Shell.

    De locatie van de startknop van Cloud Shell.

  2. Nadat de shell is geopend, moet u de Bash-omgeving selecteren.

    De Bash-omgeving selecteren.

Een API Management-exemplaar maken

  1. We gaan enkele variabelen instellen voor de CLI-opdrachten die moeten worden gebruikt om de hoeveelheid hertyping te verminderen. Vervang door <myLocation> een regio die voor u zinvol is. De APIM-naam moet een wereldwijd unieke naam zijn en het volgende script genereert een willekeurige tekenreeks. Vervang door <myEmail> een e-mailadres dat u kunt openen.

    myApiName=az204-apim-$RANDOM
    myLocation=<myLocation>
    myEmail=<myEmail>
    
  2. Maak een resourcegroep. Met de volgende opdrachten maakt u een resourcegroep met de naam az204-apim-rg.

    az group create --name az204-apim-rg --location $myLocation
    
  3. Maak een APIM-exemplaar. De az apim create opdracht wordt gebruikt om het exemplaar te maken. De --sku-name Consumption optie wordt gebruikt om het proces voor de procedure te versnellen.

    az apim create -n $myApiName \
        --location $myLocation \
        --publisher-email $myEmail  \
        --resource-group az204-apim-rg \
        --publisher-name AZ204-APIM-Exercise \
        --sku-name Consumption 
    

    Notitie

    De bewerking moet in ongeveer vijf minuten worden voltooid.

Een back-end-API importeren

In deze sectie ziet u hoe u een back-end-API met de naam OpenAPI-specificatie kunt importeren en publiceren.

  1. Zoek in de Azure-portal naar API Management-services en selecteer dit.

  2. Selecteer in het scherm API Management het API Management-exemplaar dat u hebt gemaakt.

  3. Selecteer API's in het navigatiedeelvenster van de API Management-service onder API's.

    Selecteer API's in het navigatiedeelvenster van de service.

  4. Selecteer OpenAPI in de lijst en selecteer Volledig in het pop-upvenster.

    Het dialoogvenster OpenAPI. Velden worden in de volgende tabel beschreven.

    Gebruik de waarden uit de volgende tabel om het formulier in te vullen. U kunt velden die niet worden vermeld, de standaardwaarde laten staan.

    Instelling Weergegeven als Beschrijving
    OpenAPI-specificatie https://bigconference.azurewebsites.net/ Verwijst naar de service die de API implementeert. Aanvragen worden doorgestuurd naar dit adres. De meeste benodigde informatie in het formulier wordt automatisch ingevuld nadat u dit hebt ingevoerd.
    Weergavenaam Big Conference-API Deze naam wordt weergegeven in de ontwikkelaarsportal.
    Naam big-conference-api Biedt een unieke naam voor de API.
    Beschrijving Automatisch ingevuld Geef een optionele beschrijving van de API.
  5. Selecteer Maken.

De API-instellingen configureren

De Big Conference-API wordt gemaakt. Configureer de API-instellingen.

  1. Selecteer Instellingen op de blade rechts.

  2. Controleer of dit https://bigconference.azurewebsites.net/ zich in het veld URL van de webservice bevindt.

  3. Schakel het selectievakje Abonnement dat is vereist uit.

    Geef de back-end-URL voor de API op.

  4. Selecteer Opslaan.

De API testen

Nu de API is geïmporteerd en geconfigureerd, is het tijd om de API te testen.

  1. Selecteer Testen.

    Selecteer de test in het rechterdeelvenster.

  2. Selecteer Speakers_Get. De pagina bevat queryparameters en kopteksten, indien van toepassing.

  3. Selecteer Verzenden.

    Back-end reageert met 200 OK en enkele gegevens.

Azure-resources opschonen

Wanneer u klaar bent met de resources die u in deze oefening hebt gemaakt, kunt u de volgende opdracht gebruiken om de resourcegroep en alle gerelateerde resources te verwijderen.

az group delete --name az204-apim-rg