Sdílet prostřednictvím


Kurz: Definování vlastních metadat

Tento kurz vysvětluje, jak definovat vlastní metadata, která vám pomůžou uspořádat rozhraní API a další informace v centru rozhraní API. Pro vyhledávání a filtrování a vynucování standardů zásad správného řízení ve vaší organizaci můžete použít vlastní a integrovaná metadata.

Další informace o metadatech ve službě Azure API Center najdete tady:

V tomto kurzu se naučíte používat Azure Portal k:

  • Definování vlastních metadat v centru rozhraní API
  • Zobrazení schématu metadat

Požadavky

Definování metadat

Tady definujete dva vlastní příklady metadat: obor podnikání a veřejně přístupné; pokud chcete, definujte další vlastní metadata. Když do inventáře přidáte nebo aktualizujete rozhraní API a další informace, nastavte hodnoty pro vlastní a všechna běžná předdefinovaná metadata.

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.

  1. Přihlaste se k webu Azure Portal a přejděte do centra rozhraní API.

  2. V nabídce bočního panelu v části Prostředky vyberte Metadata>+ Nová metadata.

  3. Na kartě Podrobnosti zadejte informace o metadatech.

    1. Do pole Název zadejte řádek podnikání.

    2. Volitelně zadejte popis.

    3. Vyberte předdefinované volby a zadejte volby, jako jsou Marketing, Finance, IT, Sales atd. Volitelně můžete povolit možnost Povolit výběr více hodnot. Vyberte Další.

    Snímek obrazovky znázorňující, jak přidat vlastní metadata na portálu

  4. Na kartě Zadání vyberte Požadované pro rozhraní API. Vyberte volitelné pro nasazení a prostředí. Tyto entity můžete přidat v dalších kurzech. Vyberte Další.

    Snímek obrazovky s přiřazeními metadat na portálu

  5. Na kartě Zkontrolovat a vytvořit zkontrolujte nastavení a vyberte Vytvořit.

    Metadata se přidají do seznamu na stránce Metadata .

  6. Pokud chcete přidat další příklad, vyberte + Nová metadata .

  7. Na kartě Podrobnosti zadejte informace o metadatech.

    1. Jako název zadejte veřejný přístup.

    2. Vyberte typ logická hodnota.

  8. Na kartě Zadání vyberte Požadované pro rozhraní API. Vyberte Nepoužitelné pro nasazení a prostředí.

  9. Na kartě Zkontrolovat a vytvořit zkontrolujte nastavení a vyberte Vytvořit.

    Metadata se přidají do seznamu.

Zobrazení schématu metadat

Můžete zobrazit a stáhnout schéma JSON pro metadata definovaná v centru rozhraní API. Schéma zahrnuje předdefinovaná a vlastní metadata.

  1. V nabídce vlevo v části Prostředky vyberte Metadata>Prohlížet schéma metadat.

  2. Výběrem Zobrazit schéma metadat>rozhraní API zobrazíte schéma metadat pro rozhraní API, které zahrnuje integrovaná a vlastní metadata. Můžete také zobrazit schéma metadat definované pro nasazení a prostředí ve vašem centru rozhraní API.

    Snímek obrazovky se schématem metadat na portálu

Další krok

Přidejte rozhraní API do inventáře v centru rozhraní API.