Megjegyzés
Az oldalhoz való hozzáféréshez engedély szükséges. Megpróbálhat bejelentkezni vagy módosítani a címtárat.
Az oldalhoz való hozzáféréshez engedély szükséges. Megpróbálhatja módosítani a címtárat.
Ismerje meg az Azure API Center legfontosabb fogalmait, amelyekkel központosított helyen követheti nyomon az API-kat a felderítés, az újrafelhasználás és a szabályozás érdekében.
Adatmodell
Az Azure API Center konfigurációjának fő entitásai közé tartoznak az API-k és azok verziói, definíciói és üzembe helyezései. Az egyes API-k lehetséges futtatókörnyezetei és leíró metaadatai kiegészítik a konfigurációt.
Az alábbi ábra a fő entitásokat és azok egymáshoz való viszonyát mutatja be.
API
Az Azure API Center legfelső szintű logikai entitása, az API minden nyomon követni kívánt valós API-t jelöl. Az API-központ bármilyen típusú API-kat tartalmazhat, például REST, GraphQL, gRPC, SOAP, WebSocket és Webhook. Helyi és távoli MCP-kiszolgálókat és A2A-ügynököket is felvehet az API-központ leltárába.
A leltárban lévő API-k bármely API felügyeleti megoldással kezelhetők. Használhatja például az Azure API Managementet, az Apigee API Managementet, a Kong Konnectet, a MuleSoft API Managementet vagy egy másik platformot. Az Azure API Centerben képviselt API-k felügyelet nélküliek is lehetnek.
Az API-programmenedzserek vagy a rendszergazdák létrehozhatják és kezelhetik az API-készletet az Azure API Centerben. Az Azure API Center olyan funkciókat is tartalmaz, amelyekkel az API-fejlesztők közvetlenül a fejlesztői környezetekből regisztrálhatnak API-definíciókat, például Visual Studio Code-ot vagy CI/CD-folyamatokat.
API-verzió
Az API verziószámozása az API módosításainak kezelése, és annak biztosítása, hogy a módosítások az ügyfelek megzavarása nélkül legyenek elvégezve. Az API-k több verzióval is rendelkezhetnek az életciklus szakaszaiban, amelyek mindegyike adott API-módosításokkal van összhangban. Egyes verziók jelentős vagy kompatibilitástörő módosításokat vezetnek be, míg mások kisebb fejlesztéseket is hozzáadnak. Az API-verziók a tervezéstől kezdve az előzetesen, az éles fázison vagy az elavult fázison át bármelyik életciklus-fázisban lehetnek.
API-definíció
Minden API-verzióhoz legalább egy definíciónak kell lennie, például egy REST API OpenAPI-definíciójához. Az Azure API Center lehetővé teszi a szövegként (YAML, JSON, Markdown stb.) formázott API-definíciós fájlokat. Feltöltheti többek között az OpenAPI, a gRPC, a GraphQL, az AsyncAPI, a WSDL és a WADL definíciókat.
Az API-szabályozás segítése érdekében az Azure API Center linting képességeket biztosít az API-definíciók elemzéséhez a minőség és a szervezeti szabványoknak való megfelelés érdekében.
Környezet
A környezet egy olyan helyet jelöl, ahol egy API-futtatókörnyezet üzembe helyezhető, például egy Azure API Management szolgáltatás vagy egy Apigee API Management szolgáltatás. Olyan számítási szolgáltatásban is üzembe helyezheti, mint a Kubernetes-fürt, a Web App vagy az Azure Functions-alkalmazás. Minden környezet egy életciklus-fázishoz igazodik, például fejlesztéshez, teszteléshez, előkészítéshez vagy éles környezethez. A környezetek a fejlesztői portállal vagy a felügyeleti felületekkel kapcsolatos információkat is tartalmazhatnak.
Megjegyzés
Az Azure API Center használatával nyomon követheti az API-futtatókörnyezetek bármelyikét, függetlenül attól, hogy az Azure-infrastruktúrában vannak-e üzemeltetve. Ezek a környezetek nem ugyanazok, mint az Azure Deployment Environments.
Kihelyezés
Az üzembe helyezés egy olyan hely (egy cím), ahol a felhasználók hozzáférhetnek egy API-hoz. Az API-k több üzembe helyezéssel is rendelkezhetnek, például különböző átmeneti környezetekkel vagy régiókkal. Egy API-nak például lehet egy telepítése egy belső előkészítési környezetben, és egy másik egy éles környezetben. Minden üzembe helyezés egy adott API-definícióhoz van társítva.
Metaadatok
Az Azure API Centerben metaadatértékek beállításával rendszerezheti az API-kat, az üzembe helyezéseket és más entitásokat. A metaadatok hasznosak a szabályozási szabványok kereséséhez, szűréséhez és érvényesítéséhez. Az API-központ számos gyakori beépített metaadat-tulajdonságot biztosít, például API type és lifecycle stage. Az API-központ tulajdonosa bővítheti a beépített metaadatokat úgy, hogy egyéni metaadatokat határoz meg egy metaadat-sémában az API-k, az üzemelő példányok és a környezetek rendszerezéséhez. Hozzon létre például egy API approver metaadat-tulajdonságot az API használatának jóváhagyásáért felelős személy azonosításához.
Az Azure API Center támogatja az egyéni metaadatokat, amelyek lehetnek tömbök, logikai értékek, számok, objektumok, előre definiált lehetőségek, és karakterláncok.
Az Azure API Center metaadat-sémája kompatibilis a JSON- és YAML-sémaspecifikációkkal, így lehetővé teszi a sémaérvényesítést a fejlesztői eszközökben és az automatizált folyamatokban.