Dela via

Analysera API:er i ditt API Center – Microsoft managed

  • Artikel

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. API-definitioner linteras som standard med en spektral:oas-regeluppsättning (API-formatguide).
  • API-analysrapporter genereras i Azure Portal, som visar hur api-definitionerna överensstämmer med formatmallsguiden.
  • Du kan använda Azure API Center-tillägget för Visual Studio Code för att anpassa och testa din egen API-stilguide lokalt och sedan distribuera den till ditt API Center.

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.
  • För närvarande konfigurerar du en enda regeluppsättning och den tillämpas på alla OpenAPI-definitioner i API-centret.
  • Det finns gränser för 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 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 använda Azure API Center-tillägget för Visual Studio Code för att anpassa standardregeluppsättningen för ditt API Center 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. I Visual Studio Code väljer du ikonen Azure API Center i aktivitetsfältet.
  2. .api-center-rules Öppna mappen i roten för arbetsmappen.
  3. Öppna filen i mappen för DIN API Center-resurs ruleset.yml .
  4. Ändra eller ersätt innehållet efter behov.
  5. 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).

Dricks

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