Självstudie: Definiera anpassade metadata

  • Artikel

I den här självstudien definierar du anpassade metadata som hjälper dig att organisera dina API:er och annan information i API-centret. Använd anpassade och inbyggda metadata för sökning och filtrering och för att tillämpa styrningsstandarder i din organisation.

Bakgrundsinformation om metadata i Azure API Center finns i:

I den här självstudien får du lära dig hur du använder portalen för att:

  • Definiera anpassade metadata i api-centret
  • Visa metadataschemat

Förutsättningar

Definiera metadata

Här definierar du två exempel på anpassade metadata: Verksamhetsspecifik och Offentlig, om du vill definiera egna metadata. När du lägger till eller uppdaterar API:er och annan information i inventeringen anger du värden för anpassade och alla vanliga inbyggda metadata.

Viktigt!

Ta inte med känslig, konfidentiell eller personlig information i de rubriker (namn) för metadata som du definierar. Dessa rubriker visas i övervakningsloggar som används av Microsoft för att förbättra tjänstens funktioner. Men annan metadatainformation och -värden är dina skyddade kunddata.

  1. I Azure-portalen navigerar du till ditt API-center.

  2. I den vänstra menyn går du till Tillgångar och väljer Metadata > + Nya metadata.

  3. På fliken Information anger du information om metadata.

    1. I Rubrik anger du Verksamhetsrad.

    2. Du kan också ange en Beskrivning.

    3. Välj skriv Fördefinierade alternativ och ange alternativ som Marknadsföring, Ekonomi, IT, Försäljning och så vidare. Du kan också aktivera Tillåt val av flera värden. Välj Nästa.

    Skärmbild av att lägga till anpassade metadata i portalen.

  4. På fliken Tilldelningar väljer du Obligatoriskt för API:er. Välj Valfritt för Distributioner och miljöer. (Du lägger till dessa entiteter i senare självstudier.) Välj Nästa.

    Skärmbild av metadatatilldelningar i portalen.

  5. På fliken Granska + skapa granskar du inställningarna och väljer Skapa.

    Metadata läggs till i listan på sidan Metadata .

  6. Välj + Nya metadata för att lägga till ett annat exempel.

  7. På fliken Information anger du information om metadata.

    1. I Rubrik anger du Offentlig.

    2. Välj typ Boolesk.

  8. På fliken Tilldelningar väljer du Obligatoriskt för API:er. Välj Inte tillämpligt för Distributioner och miljöer.

  9. På fliken Granska + skapa granskar du inställningarna och väljer Skapa.

    Metadata läggs till i listan.

Visa metadataschema

Du kan visa och ladda ned JSON-schemat för de metadata som definierats i api-centret. Schemat innehåller inbyggda och anpassade metadata.

  1. I den vänstra menyn går du till Tillgångar och väljer Metadata View metadata schema (Metadata > View metadata schema).

  2. Välj Visa API:er för metadataschema > för att se metadataschemat för API:er, som innehåller inbyggda och anpassade metadata. Du kan också visa metadataschemat som definierats för distributioner och miljöer i API-centret.

    Skärmbild av metadataschemat i portalen.

Nästa steg

I den här självstudien har du lärt dig hur du använder portalen för att:

  • Definiera anpassade metadata i api-centret
  • Visa metadataschemat

Nu när du har förberett metadataschemat lägger du till API:er i inventeringen i API-centret.

Registrera API:er i api-inventeringen