Metaadatok használata API-szabályozáshoz
Ez a cikk a metaadatok hátterét és az AZURE API-központ API-szabályozáshoz való használatát ismerteti. Metaadatokat definiálhat és állíthat be az API-központ API-k és egyéb entitások rendszerezéséhez és szűréséhez. A metaadatok lehetnek beépítettek vagy egyéniek, és létrehozhat egy metaadat-sémát, amely konzisztenciát kényszerít az API-k, környezetek és üzemelő példányok között.
Beépített metaadatok
Api-k, környezetek és központi telepítések létrehozásakor vagy frissítésekor az API-központban meg kell adnia bizonyos beépített metaadat-tulajdonságokat, például az API típusát (REST, WSDL stb.).
Az alábbi táblázatok az Azure API Center-entitásokhoz biztosított beépített metaadatokat sorolják fel. További részletekért tekintse meg az API Center REST API-referenciáját. A táblák nem tartalmaznak szabványos Azure-tulajdonságokat, például erőforrás-azonosítókat, megjelenítési címeket és leírásokat. Nem minden tulajdonságra van szükség.
API-k
| Metaadatok | Leírás | Példaértékek |
|---|---|---|
| kind | AZ API típusa (típusa) | REST, SOAP, GraphQL |
| életciklus-szakasz | az API fejlesztési életciklusának szakasza | tervezés, fejlesztés |
| licenc | licencinformációk az API-hoz | SPDX-azonosító, licencszövegre mutató hivatkozás |
| külső dokumentáció | az API külső dokumentációjának webhelye | Dokumentációra mutató URL-cím |
| kapcsolattartási adatok | kapcsolattartási pontok az API-hoz | e-mail-cím, név, URL-cím |
| szolgáltatási feltételek | az API szolgáltatási feltételei | A szolgáltatási feltételekre mutató URL-cím |
Környezetek
| Metaadatok | Leírás | Példaértékek |
|---|---|---|
| kind | környezet típusa (típusa) | gyártás, előkészítés, fejlesztés |
| kiszolgáló | a környezet kiszolgálóadatai | a környezetkiszolgálóra mutató típus és URL-cím |
| kiszolgáló típusa | a környezeti kiszolgáló típusa | API Management-kiszolgáló, Kubernetes-kiszolgáló, Apigee-kiszolgáló |
| regisztráció | előkészítési információk a környezethez | utasítások és a környezet fejlesztői portáljára mutató URL-cím |
Központi telepítés
| Metaadatok | Leírás | Példaértékek |
|---|---|---|
| kiszolgáló | a központi telepítés kiszolgálóadatai | Az üzembehelyezési kiszolgálóra mutató URL-cím |
| állapot | az üzembe helyezés állapota | aktív, inaktív |
Egyéni metaadatok
Egyéni metaadatok definiálása az Azure Portal, az Azure API Center REST API vagy az Azure CLI használatával az API-k, környezetek és üzemelő példányok rendszerezéséhez és szűréséhez az API-központban. Az Azure API Center az alábbi típusú egyéni metaadatokat támogatja.
| Típus | Leírás | Példa neve |
|---|---|---|
| Logikai | igaz vagy hamis | IsInternal |
| szám | Számérték | YearOfCreation |
| húr | szöveges érték | GitHubRepository |
| array | értékek listája | Címkék |
| beépített választás | a választási lehetőségek beépített listája | Osztály |
| object | összetett objektum, amely több típusból áll | APIApprover |
Fontos
Ne adjon meg bizalmas, bizalmas vagy személyes adatokat a megadott metaadatok címében (neveiben). Ezek a címek láthatók a microsoft által a szolgáltatás működésének javítására használt figyelési naplókban. A metaadatok egyéb részletei és értékei azonban a védett ügyféladatok.
Metaadatok hozzárendelése entitásokhoz
Az egyéni metaadat-tulajdonságok api-khoz, környezetekhez vagy üzembe helyezésekhez rendelhetők az API-központban. Definiálja és rendelje hozzá például a részleg metaadatait az API-khoz, hogy amikor regisztrál egy API-t, vagy új API-verziót ad hozzá, meg legyen adva az API-ért felelős részleg.
Ha entitáshoz van rendelve, a metaadatok megadása nem kötelező vagy kötelező. Szükség lehet például arra, hogy a részleg metaadatai csak API-khoz legyenek beállítva, de engedélyezze a YearOfCreation használatát a környezetek opcionális metaadataiként.
Feljegyzés
- Bármikor definiálhat egyéni metaadatokat, és az API-központban lévő API-kra és más entitásokra is alkalmazható.
- Az egyéni metaadatok definiálása után módosíthatja annak hozzárendelését egy entitásra, például az API-k esetében kötelezőről választhatóra.
- Módosíthatja a metaadat-értékeket, de nem törölheti vagy nem módosíthatja az API-kban, környezetekben és üzemelő példányokban jelenleg beállított egyéni metaadatok típusát. Először törölje az egyéni metaadatokat az entitásokból, majd törölheti vagy módosíthatja őket.
Metaadatok használata szabályozáshoz
Beépített és egyéni metaadatok használatával rendszerezheti API-kat, környezeteket és üzembe helyezéseket az API-központban. Példa:
A cégirányítási szabványok kényszerítése bizonyos metaadatok API-khoz, környezetekhez és üzemelő példányokhoz való beállításának megkövetelésével.
Keressen és szűrjön API-kat az API-központban metaadatértékek alapján. Szűrhet közvetlenül az Azure Portal API-k lapján, vagy az Azure API Center REST API vagy az Azure CLI használatával lekérdezheti az API-kat bizonyos metaadatok értékei alapján.
