Azure API Center – alapfogalmak
Ez a cikk az Azure API Center főbb fogalmait ismerteti. Az Azure API Center lehetővé teszi az API-k központi helyen történő nyomon követését a felderítéshez, az újrafelhasználáshoz és a szabályozáshoz.
Adatmodell
Az alábbi ábra az Azure API Center fő entitásainak és egymáshoz való viszonyának módját mutatja be. Az entitásokról és a kapcsolódó fogalmakról az alábbi szakaszokban talál további információt.
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.
A leltárban lévő API-k bármely API felügyeleti megoldással kezelhetők, például az Azure API Management, az Apigee API Management, a Kong Konnect, a MuleSoft API Management vagy egy másik platform. Az Azure API Centerben képviselt API-k felügyelet nélküliek is lehetnek.
Az Azure API Center API-készletét úgy tervezték, hogy api-programmenedzserek vagy informatikai rendszergazdák hozzák létre és felügyelik.
API-verzió
Az API verziószámozása az API módosításainak kezelése, és annak biztosítása, hogy ezek 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 vezethetnek be, míg mások kisebb fejlesztéseket is hozzáadnak. Az API-verziók az életciklus bármely szakaszában lehetnek – a tervezéstől kezdve az előzetes verzióig, az éles környezetig vagy az elavultig.
API-definíció
Minden API-verziót ideális esetben legalább egy definícióval kell definiálni, például egy REST API OpenAPI-definícióját. 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.
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, egy Apigee API Management szolgáltatás vagy egy számítási szolgáltatás, például Egy Kubernetes-fürt, egy webalkalmazás vagy egy Azure-függvény. 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.
Feljegyzés
Az Azure API Center használatával nyomon követheti bármelyik API-futtatókörnyezetet, függetlenül attól, hogy azokat az Azure-infrastruktúrában üzemeltetik-e. Ezek a környezetek nem ugyanazok, mint az Azure Deployment Environments.
Telepíté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 központi telepítése egy belső előkészítési környezetben, egy második pedig egy éles környezetben. Minden üzembe helyezés egy adott API-definícióhoz van társítva.
Metaadatok
Az Azure API Centerben rendszerezheti az API-kat, az üzembe helyezéseket és az egyéb entitásokat a metaadatértékek beállításával, amelyek felhasználhatók keresésre és szűrésre, valamint szabályozási szabványok kikényszerítésére. Az API-központ számos gyakori beépített metaadat-tulajdonságot biztosít, például az "API-típust" és az "életciklus-szakaszt". 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-jóváhagyó tulajdonságot, amely azonosítja az API-k használatának jóváhagyásáért felelős személyt.
Az Azure API Center támogatja a tömb, logikai, szám, objektum, előre definiált lehetőségek és sztringek egyéni metaadatait.
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.