Använda metadata för API-styrning
Den här artikeln innehåller bakgrund om metadata och hur du använder dem för API-styrning i Azure API Center. Du definierar och anger metadata för att organisera och filtrera API:er och andra entiteter i ditt API Center. Metadata kan byggas in eller anpassas och du kan utveckla ett metadataschema för att framtvinga konsekvens i dina API:er, miljöer och distributioner.
Inbyggda metadata
När du skapar eller uppdaterar API:er, miljöer och distributioner i DITT API Center anger du vissa inbyggda metadataegenskaper, till exempel API-typen (REST, WSDL och så vidare).
I följande tabeller visas inbyggda metadata för Azure API Center-entiteter. Mer information finns i API Center REST API-referensen. Tabeller innehåller inte Azure-standardegenskaper som resursidentifierare, visningsrubriker och beskrivningar. Alla egenskaper krävs inte.
API:er
| Metadata | beskrivning | Exempelvärden |
|---|---|---|
| typ | typ (typ) av API | REST, SOAP, GraphQL |
| livscykelsteg | fas i livscykeln för API-utveckling | design, utveckling |
| licens | licensinformation för API:et | SPDX-identifierare, länk till licenstext |
| extern dokumentation | webbplats för extern dokumentation för API:et | URL som pekar på dokumentation |
| kontaktinformation | kontaktpunkter för API:et | e-postadress, namn, URL |
| tjänstevillkor | användarvillkor för API:et | URL som pekar på tjänstvillkor |
Miljöer
| Metadata | beskrivning | Exempelvärden |
|---|---|---|
| typ | typ (typ) av miljö | produktion, mellanlagring, utveckling |
| server | serverinformation om miljön | typ och URL som pekar på miljöservern |
| servertyp | typ av miljöserver | API Management-server, Kubernetes-server, Apigee-server |
| registrering | onboarding-information för miljön | instruktioner och URL som pekar på miljöns utvecklarportal |
Distributioner
| Metadata | beskrivning | Exempelvärden |
|---|---|---|
| server | serverinformation om distributionen | URL som pekar på distributionsservern |
| tillstånd | distributionens tillstånd | aktiv, inaktiv |
Anpassade metadata
Definiera anpassade metadata med hjälp av Azure-portalen, Rest-API:et för Azure API Center eller Azure CLI för att organisera och filtrera API:er, miljöer och distributioner i DITT API Center. Azure API Center stöder anpassade metadata av följande typer.
| Typ | Beskrivning | Exempelnamn |
|---|---|---|
| boolean | sant eller falskt | IsInternal |
| Nummer | numeriskt värde | YearOfCreation |
| sträng | textvärde | GitHubRepository |
| matris | lista med värden | Taggar |
| inbyggt val | inbyggd lista över alternativ | Avdelning |
| objekt | komplext objekt som består av flera typer | APIApprover |
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.
Tilldela metadata till entiteter
Anpassade metadataegenskaper kan tilldelas till API:er, miljöer eller distributioner i API-centret. Definiera och tilldela till exempel avdelningsmetadata till API:er, så att när ett API registreras eller en ny API-version läggs till, anges den avdelning som ansvarar för API:et.
Om metadata tilldelas till en entitet är de valfria eller obligatoriska. Du kan till exempel kräva att avdelningsmetadata endast anges för API:er, men att YearOfCreation kan vara valfria metadata för miljöer.
Kommentar
- Definiera anpassade metadata när som helst och tillämpa på API:er och andra entiteter i api-centret.
- När du har definierat anpassade metadata kan du ändra tilldelningen till en entitet, till exempel från obligatorisk till valfri för API:er.
- Du kan ändra metadatavärden, men du kan inte ta bort eller ändra den typ av anpassade metadata som för närvarande anges i API:er, miljöer och distributioner. Ta bort de anpassade metadata från entiteterna först och sedan kan du ta bort eller ändra dem.
Använda metadata för styrning
Använd inbyggda och anpassade metadata för att organisera DINA API:er, miljöer och distributioner i API-centret. Till exempel:
Tillämpa styrningsstandarder i din organisation genom att kräva att vissa metadata anges för API:er, miljöer och distributioner.
Sök och filtrera API:er i api-centret efter metadatavärden. Du kan filtrera direkt på SIDAN API:er i Azure-portalen eller använda REST API:et för Azure API Center eller Azure CLI för att fråga API:er baserat på värden för vissa metadata.
