Dela via

Aktivera API-analys i ditt API Center – Microsoft managed

  • Artikel

Den här artikeln beskriver hur du aktiverar API-analys i Azure API Center utan att behöva hantera den själv (förhandsversion). API-analys erbjuder lintningsfunktioner för att analysera API-definitioner i din organisations API Center. Linting säkerställer att dina API-definitioner följer organisationens stilregler och genererar både enskilda rapporter och sammanfattningsrapporter. Använd API-analys för att identifiera och korrigera vanliga fel och inkonsekvenser i DINA API-definitioner.

Kommentar

Med hanterad linting och analys konfigurerar API Center en lintningsmotor och eventuella nödvändiga beroenden och utlösare. Du kan också aktivera lintning och analys manuellt.

I det här scenariot:

  1. Lägg till en linting-regeluppsättning (API-formatguide) i API-centret med hjälp av Visual Studio Code-tillägget för Azure API Center.
  2. Azure API Center kör automatiskt linting när du lägger till eller uppdaterar en API-definition. Den utlöses också för alla API-definitioner när du distribuerar en regeluppsättning till ditt API Center.
  3. Granska API-analysrapporter i Azure-portalen för att se hur dina API-definitioner överensstämmer med formatmallsguiden.
  4. Du kan också anpassa regeluppsättningen för organisationens API:er. Testa den anpassade regeluppsättningen lokalt innan du distribuerar den till api-centret.

Begränsningar

  • För närvarande analyseras endast OpenAPI-specifikationsdokument i JSON- eller YAML-format.
  • Som standard aktiverar du analys med regeluppsättningenspectral:oas. Mer information om de inbyggda reglerna finns i Spectral GitHub-lagringsplatsen.
  • För närvarande konfigurerar du en enda regeluppsättning och den tillämpas på alla OpenAPI-definitioner i API-centret.

Förutsättningar

Aktivera API-analys med Visual Studio Code

Så här aktiverar du API-analys med hjälp av standardregeluppsättningen för lintning:

  1. I Visual Studio Code öppnar du en mapp som du ska använda för att hantera regeluppsättningar för Azure API Center.

  2. Välj Ikonen Azure API Center i aktivitetsfältet.

  3. I fönstret API Center expanderar du DEN API Center-resurs där API-analys ska aktiveras.

  4. Högerklicka på Regler och välj Aktivera API-analys.

    Skärmbild av aktivering av API-lintning och analys i Visual Studio Code.

Ett meddelande meddelar dig när API-analysen har aktiverats. En mapp för API-centret skapas i , i .api-center-rulesroten för arbetsmappen. Mappen för API-centret innehåller:

  • En ruleset.yml fil som definierar standardguiden för API-format som används av lintningsmotorn.
  • En functions mapp med ett exempel på en anpassad funktion som du kan använda för att utöka regeluppsättningen.

När analysen är aktiverad analyserar lintningsmotorn API-definitioner i api-centret baserat på standardregeluppsättningen och genererar API-analysrapporter.

Visa API-analysrapporter

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

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 också välja ikonen API Analysis Report (API Analysis Report) 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.

    Dricks

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

Anpassa regeluppsättning

Du kan anpassa standardregeluppsättningen eller ersätta den som organisationens API-formatguide. Du kan till exempel utöka regeluppsättningen eller lägga till anpassade funktioner.

Så här anpassar eller ersätter du regeluppsättningen:

  1. Öppna mappen i roten på arbetsmappen .api-center-rules i Visual Studio Code.
  2. Öppna filen i mappen för API Center-resursen ruleset.yml .
  3. Ändra eller ersätt innehållet efter behov.
  4. Spara ändringarna i ruleset.yml.

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.yml 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 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).

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. Högerklicka på Regler 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.

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

Relaterat innehåll