Självstudie: Registrera API:er i api-inventeringen

Den här självstudien beskriver hur du startar API-inventeringen i din organisations API Center genom att registrera API:er och tilldela metadata med hjälp av Azure-portalen.

Mer information om API:er, API-versioner, definitioner och andra entiteter som du kan inventera i Azure API Center finns i Viktiga begrepp.

I den här självstudien får du lära dig hur du använder Azure-portalen för att:

Förutsättningar

• Ett API-center i din Azure-prenumeration. Information om hur du skapar ett finns i Snabbstart: Skapa ditt API-center.

• En eller flera API:er som du vill registrera i API-centret. Här är två exempel med länkar till deras OpenAPI-definitioner:

  • Swagger Petstore API
  • Konferens-API

• Definiera anpassade metadata för dina API:er genom att slutföra föregående självstudie, Definiera anpassade metadata.

Registrera API:er

När du registrerar (lägger till) ett API i api-centret inkluderar API-registreringen:

• En rubrik (namn), typ och beskrivning
• Versionsinformation
• Valfria länkar till dokumentation och kontakter
• Inbyggda och anpassade metadata som du har definierat

När du har registrerat ett API kan du lägga till versioner och definitioner i API:et.

Följande steg registrerar två exempel-API:er: Swagger Petstore API och Conference API (se Förutsättningar). Om du vill kan du registrera egna API:er.

1. Logga in på Azure-portalen och gå sedan till DITT API-center.

2. I sidomenyn under Tillgångar väljer du API:er>+ Registrera ett API.

3. På sidan Registrera ett API lägger du till följande information för Swagger Petstore-API:et. Du bör se de anpassade verksamhetsspecifika och offentliga metadata som du definierade i föregående självstudie längst ned på sidan.

   Inställning	Värde	Description
   API-rubrik	Ange Swagger Petstore API.	Namn som du väljer för API:et
   Identifiering	När du har angett föregående rubrik genererar Azure API Center den här identifieraren, som du kan åsidosätta.	Azure-resursnamn för API:et
   API-typ	Välj REST i listrutan.	Typ av API
   Sammanfattning	Du kan också ange en sammanfattning.	Sammanfattning av API:et
   Beskrivning	Du kan också ange en beskrivning.	Beskrivning av API:et
   Version:
   Versionsrubrik	Ange valfri versionsrubrik, till exempel v1.	Namn som du väljer för API-versionen
   Versionsidentifiering	När du har angett föregående rubrik genererar Azure API Center den här identifieraren, som du kan åsidosätta.	Azure-resursnamn för versionen
   Versionslivscykel	Gör ett val från listrutan, till exempel Testning eller Produktion.	Livscykelsteg för API-versionen
   Extern dokumentation	Du kan också lägga till en eller flera länkar till extern dokumentation.	Namn, beskrivning och URL för dokumentation för API:et
   Licens	Du kan också lägga till licensinformation.	Namn, URL och ID för en licens för API:et
   Kontaktinformation	Du kan också lägga till information för en eller flera kontakter.	Namn, e-post och URL för en kontakt för API:et
   Verksamhetsrad	Om du har lagt till dessa metadata i den föregående självstudien gör du ett val från listrutan, till exempel Marknadsföring.	Anpassade metadata som identifierar affärsenheten som äger API:et
   Offentlig	Om du har lagt till dessa metadata markerar du kryssrutan.	Anpassade metadata som identifierar om API:et endast är offentligt eller internt

   

4. Välj Skapa för att registrera API:et.

5. Upprepa föregående tre steg för att registrera ett annat API, till exempel konferens-API:et.

API:erna visas på SIDAN API:er i portalen. Om du lägger till ett stort antal API:er i API-centret använder du sökrutan och filtren på den här sidan för att hitta de API:er som du vill använda.

När du har registrerat ett API kan du visa eller redigera API:ets egenskaper. På sidan API:er väljer du API:et för att se sidor för att hantera API-registreringen.

Lägga till en API-version

Under hela livscykeln kan ett API ha flera versioner. Du kan lägga till en version i ett befintligt API i api-centret, om du vill med en definitionsfil eller -filer.

Här lägger du till en version till ett av dina API:er:

1. I Azure-portalen navigerar du till ditt API-center.

2. I sidomenyn väljer du API:er och sedan ett API, till exempel Swagger Petstore.

3. På API-sidan går du till Information och väljer Versioner>+ Lägg till version.

   

4. På sidan Lägg till API-version anger eller väljer du följande information under Versionsinformation:

   Inställning	Värde	Description
   Versionsrubrik	Ange valfri versionsrubrik, till exempel v2.	Namn som du väljer för API-versionen
   Versionsidentifiering	När du har angett föregående rubrik genererar Azure API Center den här identifieraren, som du kan åsidosätta.	Azure-resursnamn för versionen
   Versionslivscykel	Gör ett val från listrutan, till exempel Produktion.	Livscykelsteg för API-versionen

5. Azure API Center stöder definitioner i vanliga textspecifikationsformat, till exempel OpenAPI 2 och 3 för REST-API:er. Om du vill lägga till en API-definition anger eller väljer du följande information under Välj en specifikation:

   Inställning	Värde	Description
   Definitionsrubrik	Ange valfri rubrik, till exempel v2-definition.	Namn som du väljer för API-definitionen
   Identifiering av definitioner	När du har angett föregående rubrik genererar Azure API Center den här identifieraren, som du kan åsidosätta.	Azure-resursnamn för definitionen
   Beskrivning	Du kan också ange en beskrivning.	Beskrivning av API-definitionen
   Specifikationsformat	För API:et för djurarkiv väljer du OpenAPI.	Specifikationsformat för API:et
   Specifikationsversion	Ange en valfri versionsidentifierare, till exempel 3.0.	Specifikationsversion
   Fil eller URL	Bläddra till en lokal definitionsfil för Petstore-API:et eller ange en URL. Exempel-URL: https://raw.githubusercontent.com/swagger-api/swagger-petstore/refs/heads/master/src/main/resources/openapi.yaml	API-definitionsfil

   

6. Välj Skapa.

När du skapar api-inventeringen kan du dra nytta av automatiserade verktyg för att registrera API:er, till exempel Azure API Center-tillägget för Visual Studio Code och Azure CLI.

Nästa steg

API-inventeringen börjar ta form! Nu kan du lägga till information om API-miljöer och distributioner.