Analysera API:er i ditt API Center – Microsoft managed

Din organisations API-center innehåller inbyggda, Microsoft-hanterade lintningsfunktioner (förhandsversion) för att analysera API-definitioner för efterlevnad av organisationsformatregler, vilket genererar både enskilda rapporter och sammanfattningsrapporter. API-analys identifierar och hjälper dig att korrigera vanliga fel och inkonsekvenser i DINA API-definitioner.

Med API-analys:

  • Azure API Center analyserar automatiskt dina API-definitioner när du lägger till eller uppdaterar en API-definition. Lintningen för dina API-definitioner görs som standard med en spectral:oas regeluppsättning (API-formatguide).
  • API-analysrapporter genereras i Azure Portal, som visar hur api-definitionerna överensstämmer med formatmallsguiden.
  • Använd analysprofiler för att ange regeluppsättningen och filtervillkoren för de API:er som analyseras. Anpassa en profils regeluppsättning med hjälp av Azure API Center-tillägget för Visual Studio Code.

Viktigt!

Om du vill kan du aktivera självhanterad linting och analys med hjälp av en anpassad Azure-funktion, vilket översidosätter de inbyggda funktionerna. Inaktivera alla funktioner som används för självhanterad lintning innan du använder hanterad API-analys.

Begränsningar

  • För närvarande analyseras endast OpenAPI- och AsyncAPI-specifikationsdokument i JSON- eller YAML-format.
  • Det finns gränser för antalet analysprofiler och det maximala antalet API-definitioner som analyseras. Det kan ta några minuter till upp till 24 timmar att slutföra analysen.

Förutsättningar

Visa API-analysrapporter

Visa en analyssammanfattning och analysrapporterna för dina API-definitioner i Azure Portal. När API-definitioner har analyserats listar rapporterna fel, varningar och information baserat på den konfigurerade API-formatguiden.

I API-analysrapporten granskar du även regeluppsättningen som användes för analysen och historiken för lintningspass.

Så här visar du en analyssammanfattning i api-centret:

  1. Gå till API-centret i portalen.

  2. I den vänstra menyn, under Styrning, väljer du API-analys. Sammanfattningen visas.

    Skärmbild av API-analyssammanfattningen i portalen.

  3. Du kan valfritt välja ikonen för API-analysrapport för en API-definition. Definitionens API-analysrapport visas, som du ser i följande skärmbild.

    Skärmbild av en API-analysrapport i portalen.

    Tips

    Du kan också visa API-analysrapporten genom att välja Analys från API-definitionens menyrad.

Hantera analysprofiler

Azure API Center använder analysis-profiler för lintning och analys av API:er. En analysprofil anger en regeluppsättning och eventuellt filtervillkor för API:er som analyseras. Standardanalysprofilen tillämpar regeluppsättningen på spectral:oas alla OpenAPI- och AsyncAPI-definitioner.

Du kan anpassa regeluppsättningen och definiera filtervillkor i standardprofilen, eller så kan du skapa en ny profil. Du kanske till exempel vill använda en profil för API:er som är under utveckling och en annan för API:er som finns i produktion.

Anmärkning

I standardplanen för API Center kan du skapa upp till tre analysprofiler. Endast en enskild profil stöds i den kostnadsfria planen.

Så här skapar du en analysprofil:

  1. I Azure-portalen navigerar du till ditt API-center.
  2. I den vänstra menyn under Styrning väljer du API-analys>Hantera analysprofiler>+ Skapa analysprofil.
  3. I fönstret Skapa ny analysprofil anger du ett namn och en beskrivning för profilen.
  4. I Regeluppsättning visas typ av analysverktyg (lintningsmotor) för regeluppsättningen. För närvarande stöds endast Spectral.
  5. Under Definiera filtervillkor lägger du till ett eller flera filtervillkor för API-definitioner som profilen tillämpas på.
  6. Välj Skapa.

Skärmbild av hur du skapar en analysprofil i portalen.

Profilen skapas och en regeluppsättning skapas. Om du vill visa den aktuella regeluppsättningen väljer du profilen och i kontextmenyn (...) väljer du Visa regeluppsättningen.

Om du vill anpassa regeluppsättningen fortsätter du till följande avsnitt.

Anpassa profilens regeluppsättning

Använd Visual Studio Code-tillägget för Azure API Center för att anpassa en profils regeluppsättning. När du har anpassat regeluppsättningen och testat den lokalt kan du distribuera den tillbaka till API-centret.

  1. I Visual Studio Code väljer du ikonen Azure API Center i aktivitetsfältet.
  2. I fönstret API Center expanderar du den API Center-resurs som du arbetar med och expanderar Profiler.
  3. Expandera den profil som du vill ändra och välj ruleset.yaml.
  4. Ändra eller ersätt innehållet efter behov.
  5. Spara ändringarna i ruleset.yaml.

Testa regeluppsättningen lokalt

Verifiera den lokalt innan du distribuerar den anpassade regeluppsättningen till API-centret. Azure API Center-tillägget för Visual Studio Code ger integrerat stöd för API-specifikationslintning med Spectral.

  1. I Visual Studio Code använder du kortkommandot Ctrl+Skift+P för att öppna kommandopaletten.

  2. Skriv Azure API Center: Ange aktiv API Style Guide och tryck på Retur.

  3. Välj Välj lokal fil och ange den ruleset.yaml fil som du har anpassat. Tryck på Retur.

    Det här steget gör den anpassade regeluppsättningen till den aktiva API-formatguiden för lokal linting.

När du nu öppnar en OpenAPI-baserad API-definitionsfil utlöses en lokal lintningsåtgärd automatiskt i Visual Studio Code. Resultaten visas infogade i redigeraren och i fönstret Problem (Visa > problem eller Ctrl+Skift+M).

Tips

API-utvecklare i din organisation kan också använda den här lokala lintningsfunktionen för att förbättra sina API-definitioner innan de registrerar API:er i api-centret.

Skärmbild av linting av en API-definition i Visual Studio Code.

Granska lintningsresultaten. Gör alla nödvändiga justeringar av regeluppsättningen och fortsätt att testa den lokalt tills den fungerar som du vill.

Distribuera regeluppsättning till ditt API Center

Så här distribuerar du den anpassade regeluppsättningen till api-centret:

  1. I Visual Studio Code väljer du ikonen Azure API Center i aktivitetsfältet.
  2. I fönstret API Center expanderar du den API Center-resurs där du anpassade regeluppsättningen.
  3. Expandera Profiler.
  4. Högerklicka på profilen där du anpassade regeluppsättningen och välj Distribuera regler till API Center.

Ett meddelande meddelar dig när reglerna har distribuerats till DITT API Center. Linting-motorn använder den uppdaterade regeluppsättningen för att analysera API-definitioner i profilen.

Om du vill se resultatet av linting med den uppdaterade regeluppsättningen kan du visa API-analysrapporterna i portalen.

Relaterat innehåll

  • Last updated on