Poznámka:
Přístup k této stránce vyžaduje autorizaci. Můžete se zkusit přihlásit nebo změnit adresáře.
Přístup k této stránce vyžaduje autorizaci. Můžete zkusit změnit adresáře.
Tento článek obsahuje základní informace o metadatech a jeho použití pro zásady správného řízení rozhraní API ve službě Azure API Center. Definujete a nastavíte metadata pro uspořádání a filtrování rozhraní API a dalších entit v centru rozhraní API. Metadata můžou být sestavená nebo vlastní a můžete vyvíjet schéma metadat, které vynucuje konzistenci napříč rozhraními API, prostředími a nasazeními.
Integrovaná metadata
Při vytváření nebo aktualizaci rozhraní API, prostředí a nasazení v centru rozhraní API nastavíte určité předdefinované vlastnosti metadat, jako je typ rozhraní API (REST, WSDL atd.).
Následující tabulky uvádějí předdefinovaná metadata poskytovaná pro entity Azure API Center. Podrobnosti najdete v referenčních informacích k rozhraní REST API služby API Center. Tabulky nezahrnují standardní vlastnosti Azure, jako jsou identifikátory prostředků, zobrazované názvy nebo popisy. Nejsou vyžadovány všechny vlastnosti.
Programovací rozhraní (API)
| Metadatové informace | Description | Ukázkové hodnoty |
|---|---|---|
| laskavý | Druh (typ) rozhraní API | REST, SOAP, GraphQL |
| fáze životního cyklu | Fáze životního cyklu vývoje rozhraní API | Návrh, vývoj |
| licence | Informace o licenci pro rozhraní API | Identifikátor SPDX, odkaz na text licence |
| externí dokumentace | Web pro externí dokumentaci k rozhraní API | Adresa URL odkazující na dokumentaci |
| kontaktní informace | Kontaktní body pro rozhraní API | E-mailová adresa, jméno, adresa URL |
| podmínky služby | Podmínky služby pro rozhraní API | Adresa URL odkazující na podmínky služby |
Environments
| Metadatové informace | Description | Ukázkové hodnoty |
|---|---|---|
| laskavý | Druh (typ) prostředí | Výroba, příprava, vývoj |
| server | Informace o serveru prostředí | Typ a adresa URL odkazující na server prostředí |
| typ serveru | Typ serveru prostředí | Server API Management, server Kubernetes, server Apigee |
| onboarding | Informace o onboardingu pro prostředí | Pokyny a adresa URL odkazující na portál pro vývojáře prostředí |
Nasazení
| Metadatové informace | Description | Ukázkové hodnoty |
|---|---|---|
| server | Informace o serveru nasazení | Adresa URL odkazující na server nasazení |
| stav | Stav nasazení | Aktivní, neaktivní |
Vlastní metadata
Definujte vlastní metadata pomocí webu Azure Portal, rozhraní REST API služby Azure API Center nebo Azure CLI , které vám pomůžou uspořádat a filtrovat rozhraní API, prostředí a nasazení ve vašem centru rozhraní API. Azure API Center podporuje vlastní metadata následujících typů.
| Typ | Description | Příklad názvu |
|---|---|---|
| Boolean | Pravda nebo nepravda | IsInternal |
| číslo | Číselná hodnota | YearOfCreation |
| řetězec | Textová hodnota | GitHubRepository |
| pole | Seznam hodnot | Štítky |
| integrovaná volba | Předdefinovaný seznam voleb | Department |
| objekt | Komplexní objekt složený z více typů | APIApprover |
Důležité
Do názvů (názvů) definovaných metadat nezahrnujte žádné citlivé, důvěrné ani osobní údaje. Tyto názvy jsou viditelné v protokolech monitorování, které Microsoft používá ke zlepšení funkčnosti služby. Další podrobnosti a hodnoty metadat jsou však chráněná zákaznická data.
Přiřazení metadat entit
Vlastní vlastnosti metadat se dají přiřadit k rozhraním API, prostředím nebo nasazením v centru rozhraní API. Můžete například definovat a přiřadit metadata oddělení k rozhraním API, aby se při registraci rozhraní API nebo přidání nové verze rozhraní API zadalo oddělení zodpovědné za rozhraní API.
Pokud je entita přiřazená, metadata jsou volitelná nebo povinná. Můžete například vyžadovat, aby metadata oddělení byla nastavena pouze pro rozhraní API, ale pro prostředí mohla být volitelná metadata YearOfCreation .
Poznámka:
- Definujte vlastní metadata kdykoli a platí pro rozhraní API a další entity v centru rozhraní API.
- Po definování vlastních metadat můžete změnit jeho přiřazení k entitě, například z požadavku na volitelné pro rozhraní API.
- Hodnoty metadat můžete změnit, ale nemůžete odstranit ani změnit typ vlastních metadat, která jsou aktuálně nastavená v rozhraních API, prostředích a nasazeních. Nejprve zrušte přiřazení vlastních metadat od entit a pak je můžete odstranit nebo změnit.
Použijte metadata pro správu.
Pomocí integrovaných a vlastních metadat uspořádejte svá rozhraní API, prostředí a nasazení v centru rozhraní API. Například:
Vynucujte standardy zásad správného řízení ve vaší organizaci tím, že budete muset nastavit určitá metadata pro rozhraní API, prostředí a nasazení.
Vyhledávání a filtrování rozhraní API v centru rozhraní API podle hodnot metadat. Můžete filtrovat přímo na stránce rozhraní API na webu Azure Portal nebo pomocí rozhraní REST API Center nebo Azure CLI dotazovat rozhraní API na základě hodnot určitých metadat.
