Oktatóanyag: API-k regisztrálása az API-készletben

Ez az oktatóanyag bemutatja, hogyan indíthatja el az API-leltárt a szervezet API-központjában api-k regisztrálásával és metaadatok hozzárendelésével az Azure Portalon.

Az API-król, API-verziókról, definíciókról és egyéb, az Azure API Centerben leltározható entitásokról további információt a fő fogalmakban talál.

Ebben az oktatóanyagban megtudhatja, hogyan használhatja az Azure Portalt a következőkre:

• Egy vagy több API regisztrálása
• API-verzió hozzáadása API-definícióval

Előfeltételek

• Egy API-központ az Azure-előfizetésben. A létrehozáshoz tekintse meg az API-központ létrehozása című rövid útmutatót.

• Egy vagy több API, amelyet regisztrálni szeretne az API-központban. Íme két példa az OpenAPI-definíciókra mutató hivatkozásokkal:

  • Swagger Petstore API
  • Konferencia API

• Egyéni metaadatok definiálása az API-khoz az előző oktatóanyag, Az egyéni metaadatok definiálása című oktatóanyag végrehajtásával.

API-k regisztrálása

Amikor regisztrál (hozzáad) egy API-t az API-központban, az API-regisztráció a következőket tartalmazza:

• Cím (név), típus és leírás
• Verzióinformációk
• A dokumentációra és a névjegyekre mutató választható hivatkozások
• Ön által definiált beépített és egyéni metaadatok

Az API regisztrálása után verziókat és definíciókat adhat hozzá az API-hoz.

Az alábbi lépések két minta API-t regisztrálnak: a Swagger Petstore API-t és a Konferencia API-t (lásd az előfeltételeket). Ha szeretné, regisztráljon saját API-kat.

1. Jelentkezzen be az Azure Portalra, majd lépjen az API-központba.

2. Az oldalsáv menü Eszközök területén válassza az API-k> regisztrálása lehetőséget.

3. Az API regisztrálása lapon adja hozzá a következő információkat a Swagger Petstore API-hoz. Az előző oktatóanyagban definiált egyéni üzletági és nyilvános metaadatoknak a lap alján kell megjelennie.

   Setting	Érték	Description
   API-cím	Adja meg a Swagger Petstore API-t.	Az API-hoz választott név
   Azonosítás	Az előző cím megadása után az Azure API Center létrehozza ezt az azonosítót, amelyet felülbírálhat.	Az API Azure-erőforrásneve
   API-típus	Válassza a REST lehetőséget a legördülő listában.	Az API típusa
   Összefoglalás	Igény szerint adjon meg egy összegzést.	Az API összefoglaló leírása
   Leírás	Igény szerint adjon meg egy leírást.	Az API leírása
   verzió
   Verzió címe	Adjon meg egy tetszőleges verziócímet, például 1-es verziót.	Az API-verzióhoz választott név
   Verzióazonosító	Az előző cím megadása után az Azure API Center létrehozza ezt az azonosítót, amelyet felülbírálhat.	Azure-erőforrás neve a verzióhoz
   Verzió életciklusa	Válasszon a legördülő listából, például tesztelés vagy éles környezet.	Az API-verzió életciklusának szakasza
   Külső dokumentáció	Szükség esetén hozzáadhat egy vagy több külső dokumentációra mutató hivatkozást.	Az API dokumentációjának neve, leírása és URL-címe
   Licenc	Igény szerint adja hozzá a licencinformációkat.	Az API-licenc neve, URL-címe és azonosítója
   Kapcsolattartási adatok	Igény szerint egy vagy több partner adatait is hozzáadhatja.	Az API-hoz tartozó partner neve, e-mail-címe és URL-címe
   Üzletág	Ha ezt a metaadatokat az előző oktatóanyagban adta hozzá, válasszon a legördülő listából, például a Marketingből.	Egyéni metaadatok, amelyek azonosítják az API-t birtokban lévő üzleti egységet
   Nyilvános elérésű	Ha hozzáadta ezt a metaadatot, jelölje be a jelölőnégyzetet.	Egyéni metaadatok, amelyek azt azonosítják, hogy az API nyilvános vagy csak belső

   

4. Válassza a Létrehozás lehetőséget az API regisztrálásához.

5. Ismételje meg az előző három lépést egy másik API, például a Konferencia API regisztrálásához.

Jótanács

Amikor regisztrál egy API-t az Azure Portalon, kiválaszthatja az előre definiált API-típusok bármelyikét, vagy megadhat egy másikat.

Az API-k megjelennek a portál API-k oldalán. Ha nagy számú API-t ad hozzá az API-központhoz, használja a keresőmezőt és a szűrőket ezen a lapon a kívánt API-k megkereséséhez.

Az API regisztrálása után megtekintheti vagy szerkesztheti az API tulajdonságait. Az API-k lapon válassza ki az API-t az API-regisztráció kezeléséhez szükséges lapok megtekintéséhez.

API-verzió hozzáadása

Az API teljes életciklusa során több verzióval is rendelkezhet. Egy verziót hozzáadhat egy meglévő API-hoz az API-központban, opcionálisan definíciós fájlokkal vagy fájlokkal.

Itt egy verziót adhat hozzá az egyik API-hoz:

1. Az Azure Portalon keresse meg az API-központot.

2. Az oldalsáv menüjében válassza az API-kat, majd válasszon ki egy API-t, például a Swagger Petstore-t.

3. Az API lap Részletek területén

   

4. Az API verziószámának hozzáadása lapon adja meg vagy válassza ki a következő információkat a Verzió részletei csoportban:

   Setting	Érték	Description
   Verzió címe	Adjon meg egy tetszőleges verziócímet, például 2-es verziót.	Az API-verzióhoz választott név
   Verzióazonosító	Az előző cím megadása után az Azure API Center létrehozza ezt az azonosítót, amelyet felülbírálhat.	Azure-erőforrás neve a verzióhoz
   Verzió életciklusa	Válasszon a legördülő listából, például az Éles környezetből.	Az API-verzió életciklusának szakasza

5. Az Azure API Center támogatja a definíciókat a gyakori szövegspecifikációs formátumokban, például az OpenAPI 2 és a 3 for REST API-k esetében. API-definíció hozzáadásához adja meg vagy válassza ki a következő információkat a Specifikáció kiválasztása területen:

   Setting	Érték	Description
   Definíció címe	Adjon meg egy tetszőleges címet, például v2-definíciót.	Az API-definícióhoz választott név
   Definíció azonosítása	Az előző cím megadása után az Azure API Center létrehozza ezt az azonosítót, amelyet felülbírálhat.	A definíció Azure-erőforrásneve
   Leírás	Igény szerint adjon meg egy leírást.	Az API-definíció leírása
   Specifikáció formátuma	A Petstore API-hoz válassza az OpenAPI lehetőséget.	Az API specifikációs formátuma
   Specifikáció verziója	Adja meg a választott verzióazonosítót, például a 3.0-t.	Specifikáció verziója
   Fájl vagy URL	Keresse meg a Petstore API helyi definíciós fájlját, vagy adjon meg egy URL-címet. Példa URL-címe: https://raw.githubusercontent.com/swagger-api/swagger-petstore/refs/heads/master/src/main/resources/openapi.yaml	API-definíciós fájl

   

6. Válassza a Create gombot.

Az API-készlet összeállítása során használja ki az API-k regisztrálásához használt automatizált eszközöket, például a Visual Studio Code Azure API Center bővítményét és az Azure CLI-t.

Következő lépés

Az API-készlet kezd formát ölteni! Most már hozzáadhat információkat az API-környezetekről és az üzemelő példányokról.

API-környezetek és -üzemelő példányok hozzáadása