Dela via


Anpassa API Center-portalen

I den här artikeln beskrivs inställningar som du kan anpassa i API Center-portalen (förhandsversion). API Center-portalen är en Azure-hanterad webbplats som utvecklare och andra intressenter i din organisation använder för att identifiera API:erna i ditt API Center.

Information om hur du konfigurerar API Center-portalen för inledande användning och inloggning finns i Konfigurera API Center-portalen.

Anmärkning

API Center-portalen är för närvarande i förhandsversion.

Portalsinställningssida

Konfigurera INSTÄLLNINGAR för API Center-portalen i Azure-portalen. Så här öppnar du inställningssidan:

  1. Gå till DITT API-center i Azure-portalen.
  2. Under API Center-portalen väljer du Inställningar.
  3. Klicka på flikarna för att visa och anpassa inställningarna.
  4. Välj Spara + publicera för att tillämpa ändringarna.

Skärmbild av inställningarna för API Center-portalen i Azure-portalen.

Viktigt!

Välj Spara + publicera varje gång du gör ändringar i inställningarna. Innan du publicerar visas inte ändringarna i API Center-portalen.

Webbplatsprofil

På fliken Webbplatsprofil kan du ange ett anpassat namn som visas i det övre fältet i den publicerade portalen.

Skärmbild av anpassat namn i API Center-portalen.

API-synlighet

På fliken API-synlighet kontrollerar du vilka API:er som kan identifieras (visas) för API Center-portalanvändare. Synlighetsinställningar gäller för alla användare av API Center-portalen.

API Center-portalen använder Api:et för Azure API Center-dataplan för att hämta och visa API:er i api-centret, och som standard visas alla API:er för inloggade användare med Azure RBAC-behörigheter.

Om du bara vill göra specifika API:er synliga lägger du till filtervillkor för API:er baserat på inbyggda egenskaper. Välj till exempel att endast visa API:er av vissa typer (t.ex. REST eller GraphQL) eller baserat på vissa specifikationsformat (till exempel OpenAPI).

Skärmbild av att lägga till API-synlighetsvillkor i portalen.

Anonym åtkomst

På fliken API-synlighet kan du även aktivera anonym läsåtkomst till Azure API Center-dataplans-API:et, vilket gör att oautentiserade användare kan identifiera API-inventeringen via direkta API-anrop. Aktivera till exempel den här inställningen för att göra API:er identifierbara för oautentiserade användare när du själv är värd för API Center-portalen .

Försiktighet

När du aktiverar anonym åtkomst bör du se till att inte exponera känslig information i API-definitioner eller -inställningar.

Om det är aktiverat på fliken Semantisk sökning kompletterar API Center-portalen grundläggande namnbaserad API-sökning med AI-assisterad semantisk sökning som bygger på API-namn, beskrivningar och valfritt anpassade metadata. Semantisk sökning är endast tillgängligt i Standard-planen .

Användare kan söka efter API:er med hjälp av frågor på naturligt språk, vilket gör det lättare att hitta API:er baserat på deras avsikt. Om en utvecklare till exempel söker efter "Jag behöver ett API för inventeringshantering" kan portalen föreslå relevanta API:er, även om API-namnen eller beskrivningarna inte innehåller de exakta orden.

Tips/Råd

När du använder den kostnadsfria planen för Azure API Center kan du enkelt uppgradera till Standard-planen för att aktivera fullständiga tjänstfunktioner, inklusive semantisk sökning i API Center-portalen.

Om du vill använda AI-assisterad sökning när du är inloggad på API Center-portalen klickar du i sökrutan, väljer Sök med AI och anger en fråga.

Skärmbild av semantiska sökresultat i API Center-portalen.

Anpassade metadata

På fliken Metadata kan du välja anpassade metadataegenskaper som du vill exponera i API-information och semantisk sökning.

Aktivera åtkomst till testkonsolen för API:er

Du kan konfigurera användarinställningar för att ge detaljerad behörighet till API:er och deras specifika versioner i DITT API Center. Konfigurera till exempel vissa API-versioner för att använda API-nycklar för autentisering och skapa en åtkomstprincip som endast tillåter specifika användare att autentisera med hjälp av dessa nycklar.

Åtkomstprinciper gäller även för funktionen "Prova det här API:et" för API:er i API Center-portalen, vilket säkerställer att endast portalanvändare med rätt åtkomstprincip kan använda testkonsolen för dessa API-versioner. Läs mer om att auktorisera åtkomst till API:er