Självstudie: Registrera API:er i api-inventeringen
I den här självstudien startar du API-inventeringen i din organisations API Center genom att registrera API:er och tilldela metadata med hjälp av Azure Portal.
Bakgrundsinformation 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 portalen för att:
- Registrera ett eller flera API:er
- Lägga till en API-version med en API-definition
Förutsättningar
Ett API-center i din Azure-prenumeration. Om du inte redan har skapat ett kan du läsa 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:
Slutför föregående självstudie, Definiera anpassade metadata, för att definiera anpassade metadata för dina API:er.
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.
I den vänstra menyn under Tillgångar väljer du API:er>+ Registrera ett API.
På sidan Registrera ett API lägger du till följande information för Swagger Petstore-API:et. Du ser de anpassade verksamhetsspecifika och offentliga metadata som du definierade i föregående självstudie längst ned på sidan.
Inställning Värde beskrivning 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. Sammanfattningsbeskrivning 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. Livscykelfasen 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. 
Välj Skapa. API:et är registrerat.
Upprepa föregående tre steg för att registrera ett annat API, till exempel konferens-API:et.
Dricks
När du registrerar ett API i portalen kan du välja någon av de fördefinierade API-typerna eller ange en annan typ av val.
API:erna visas på SIDAN API:er i portalen. När du har lagt 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:
Gå till API-centret i portalen.
I den vänstra menyn väljer du API:er och sedan ett API, till exempel Swagger Petstore.
På API-sidan går du till Information och väljer Versioner>+ Lägg till version.
På sidan Lägg till API-version :
Ange eller välj följande information:
Inställning Värde beskrivning 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. Livscykelfasen för API-versionen. Välj Skapa. Versionen läggs till.
Lägga till en definition i din version
Vanligtvis vill du lägga till en API-definition i DIN API-version. Azure API Center stöder definitioner i vanliga textspecifikationsformat, till exempel OpenAPI 2 och 3 för REST-API:er.
Så här lägger du till en API-definition i din version:
På sidan Versioner för ditt API väljer du din API-version.
I den vänstra menyn i API-versionen går du till Information och väljer Definitioner>+ Lägg till definition.
På sidan Lägg till definition :
Ange eller välj följande information:
Inställning Värde beskrivning Title Ange valfri rubrik, till exempel v2-definition. Namn som du väljer för API-definitionen. 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 definitionen. Beskrivning Du kan också ange en beskrivning. Beskrivning av API-definitionen. Specifikationsnamn 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. Dokument 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.yamlAPI-definitionsfil. 
Välj Skapa. Definitionen läggs till.
I den här självstudien har du lärt dig hur du använder portalen för att:
- Registrera ett eller flera API:er
- Lägga till en API-version med en API-definition
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.