Zelfstudie: Meerdere versies van uw API publiceren

Er zijn tijden wanneer het niet praktisch is dat alle aanroepers voor uw API dezelfde versie gebruiken. Wanneer aanroepers willen upgraden naar een nieuwere versie willen ze een gemakkelijk te begrijpen benadering. Zoals in deze zelfstudie wordt weergegeven, is het mogelijk om meerdere versies te bieden in Azure API Management.

Zie Versiesrevisies &voor achtergrond.

In deze zelfstudie leert u het volgende:

  • Een nieuwe versie toevoegen aan een bestaande API
  • Een versieschema kiezen
  • Voeg de versie toe aan een product
  • Blader door de portal voor ontwikkelaars om de versie te zien

Versies weergegeven in het Azure-portaal

Vereisten

Een nieuwe versie toevoegen

  1. Blader in het Azure-portaal naar uw API Management-exemplaar.
  2. Selecteer API's.
  3. Selecteer Demo Conference API in de lijst met API's.
  4. Selecteer het contextmenu ( ... ) naast Demo Conference API.
  5. Selecteer Versie toevoegen.

Contextmenu van API - versie toevoegen

Tip

Versies kunnen ook ingeschakeld worden wanneer u een nieuwe API maakt. Selecteer Versie van deze API? in het scherm API toevoegen.

Kies een versiebeheerschema

In Azure API Management kiest u hoe oproepende functies de API-versie opgeven door een schema voor versiebeheer te selecteren: pad, header of querytekenreeks. In het volgende voorbeeld wordt pad gebruikt als schema voor versiebeheer.

Voer de waarden in uit de volgende tabel. Selecteer vervolgens Maken om uw versie te maken.

Versievenster toevoegen

Instelling Waarde Beschrijving
Naam demo-conference-api-v1 Unieke naam in uw API Management-exemplaar.

Omdat een versie een nieuwe API is, gebaseerd op de revisie van een API, is deze instelling de naam van de nieuwe API.
Schema voor versiebeheer Pad De manier waarop oproepende functie de API-versie opgeven.
Versie-id v1 Schema-specifieke indicator van de versie. Voor Pad, het achtervoegsel voor het URL-pad van de API.

Als u Header of Querytekenreeks selecteert, voer dan een extra waarde in: de naam van de parameter voor de header of querytekenreeks.

Er wordt een gebruiksvoorbeeld weergegeven.
Producten Onbeperkt Optioneel een of meer producten waaraan de API-versie gekoppeld is. Als u de API wilt publiceren, moet u deze koppelen aan een product. U kunt de versie later ook toevoegen aan een product.

Nadat u de versie hebt gemaakt, wordt deze weergegeven onder Demo Conference API in de API-lijst. U ziet nu twee API's: Origineel en v1.

Versies vermeld in een API in Azure Portal

Notitie

Als u een versie aan een niet-samengestelde API toevoegt, wordt automatisch ook een Origineel gemaakt. Deze versie reageert op de standaard-URL. Een Originele versie maken zorgt ervoor dat eventuele bestaande aanroepfuncties niet worden onderbroken door het proces van het toevoegen van een versie. Als u een nieuwe API met versies maakt die aan het begin zijn ingeschakeld, wordt geen Origineel gemaakt.

Een versie bewerken

Nadat u de versie hebt toegevoegd, kunt u deze nu bewerken en configureren als een API die gescheiden is van een origineel. Wijzigingen in één versie hebben geen invloed op een andere. Voeg bijvoorbeeld API-bewerkingen toe of verwijder deze of bewerk de OpenAPI-specificatie. Zie Een API bewerken voor meer informatie.

Voeg de versie toe aan een product

Als aanroepers de nieuwe versie willen zien, moet deze worden toegevoegd aan een product. Als u de versie nog niet aan een product hebt toegevoegd, dan kunt u deze op elk gewenst moment toevoegen aan een product.

Bijvoorbeeld om de versie toe te voegen aan het Onbeperkt product:

  1. Blader in het Azure-portaal naar uw API Management-exemplaar.
  2. Selecteer Producten>Onbeperkt>API's>+ Toevoegen.
  3. Selecteer Demo Conference API, versie v1.
  4. Klik op Selecteren.

Versie toevoegen aan het product

Versiesets gebruiken

Wanneer u meerdere versies maakt, maakt de Azure Portal een versieset, die een set versies voor één logische API vertegenwoordigt. Selecteer de naam van een API met meerdere versies. In de Azure Portal wordt de versieset weergegeven. U kunt de naam en beschrijving van een virtuele set aanpassen.

U kunt rechtstreeks communiceren met versiesets met behulp van de Azure CLI:

Als u al uw versiesets wilt zien, voert u de opdracht az apim api versionset list list uit:

az apim api versionset list --resource-group apim-hello-world-resource-group \
    --service-name apim-hello-world --output table

Wanneer de Azure Portal een versieset voor u maakt, wordt er een alfanumerieke naam toegewezen, die wordt weergegeven in de kolom Naam van de lijst. Gebruik deze naam in andere Azure CLI-opdrachten.

Voer de opdracht az apim apim api versionset show uit om details over een versieset weer te geven:

az apim api versionset show --resource-group apim-hello-world-resource-group \
    --service-name apim-hello-world --version-set-id 00000000000000000000000

Zie Versies in Azure API Management voor meer informatie over versiesets.

Blader door de portal voor ontwikkelaars om de versie te zien

Als u het ontwikkelaarsportaal heeft uitgeprobeerd, kunt u daar API-versies terugvinden.

  1. Selecteer ontwikkelaarsportal in het menu bovenaan.
  2. Selecteer API's en selecteer vervolgens Demo Conference API.
  3. U ziet een vervolgkeuzelijst met meerdere versies naast de naam van de API.
  4. Selecteer v1.
  5. U ziet de Verzoek-URL van de eerste bewerking in de lijst. Het laat zien dat het API URL-pad v1 bevat.

Volgende stappen

In deze zelfstudie heeft u het volgende geleerd:

  • Een nieuwe versie toevoegen aan een bestaande API
  • Een versieschema kiezen
  • Voeg de versie toe aan een product
  • Blader door de portal voor ontwikkelaars om de versie te zien

Ga door naar de volgende zelfstudie: