Dela via

Självstudie: Lägga till miljöer och distributioner för API:er

  • Artikel

Utöka inventeringen i API-centret genom att lägga till information om API-miljöer och distributioner.

  • En miljö representerar en plats där en API-körning kan distribueras, till exempel en API-hanteringsplattform.

  • En distribution är en plats (en adress) där användare kan komma åt ett API.

Bakgrundsinformation om API:er, distributioner och andra entiteter som du kan inventera i Azure API Center finns i Viktiga begrepp.

I den här självstudien får du lära dig hur du använder portalen för att:

  • Lägga till information om API-miljöer
  • Lägga till information om API-distributioner

Förutsättningar

Lägga till en miljö

Använd api-centret för att hålla reda på dina verkliga API-miljöer. Du kan till exempel använda Azure API Management eller någon annan lösning för att distribuera, skydda och övervaka några av dina API:er. Eller så kan du hantera vissa API:er direkt med hjälp av en beräkningstjänst eller ett Kubernetes-kluster.

Här lägger du till information om en fiktiv Azure API Management-miljö i ditt API Center. Om du vill kan du lägga till information om en av dina befintliga miljöer. Du konfigurerar både inbyggda metadata och eventuella anpassade metadata som du definierade i en tidigare självstudie.

  1. Gå till API-centret i portalen.

  2. I den vänstra menyn under Tillgångar väljer du Miljöer>+ Ny miljö.

  3. Lägg till följande information på sidan Ny miljö . Om du tidigare har definierat anpassade affärsmetadata eller andra metadata som tilldelats miljöer visas de längst ned på sidan.

    Inställning Värde beskrivning
    Miljörubrik Ange Mina tester. Namn som du väljer för miljön.
    Identifiering När du har angett föregående rubrik genererar Azure API Center den här identifieraren, som du kan åsidosätta. Azure-resursnamn för miljön.
    Miljötyp Välj Testa i listrutan. Typ av miljö för API:er.
    Beskrivning Du kan också ange en beskrivning. Beskrivning av miljön.
    Server
    Typ Du kan också välja Azure API Management i listrutan. Typ av API-hanteringslösning som används.
    URL för hanteringsportalen Du kan också ange en URL för ett hanteringsgränssnitt, till exempel https://admin.contoso.com URL för hanteringsgränssnittet för miljön.
    Introduktion
    URL för utvecklingsportalen Du kan också ange en URL för en utvecklarportal, till exempel https://developer.contoso.com URL för gränssnitt för registrering av utvecklare i miljön.
    Instruktioner Du kan också välja Redigera och ange registreringsinstruktioner i Standard Markdown. Instruktioner för att registrera api:er från miljön.
    Verksamhetsrad Om du har lagt till dessa anpassade metadata kan du välja att göra ett val från listrutan, till exempel IT. Anpassade metadata som identifierar affärsenheten som hanterar miljön.

    Skärmbild av att lägga till en API-miljö i portalen.

  4. Välj Skapa. Miljön visas i listan över miljöer.

Lägga till en distribution

API Center kan också hjälpa dig att katalogisera dina API-distributioner – de körningsmiljöer där DE API:er som du spårar distribueras.

Här lägger du till en distribution genom att associera ett av dina API:er med den miljö som du skapade i föregående avsnitt. Du konfigurerar både inbyggda metadata och eventuella anpassade metadata som du har definierat.

  1. Gå till API-centret i portalen.

  2. I den vänstra menyn under Tillgångar väljer du API:er.

  3. Välj ett API, till exempel konferens-API:et.

  4. På sidan Konferens-API går du till Information och väljer Distributioner>+ Lägg till distribution.

  5. Lägg till följande information på sidan Lägg till distribution . Om du tidigare har definierat anpassade affärsmetadata eller andra metadata som tilldelats miljöer visas de längst ned på sidan.

    Inställning Värde beskrivning
    Title Ange V1-distribution. Namn som du väljer för distributionen.
    Identifiering När du har angett föregående rubrik genererar Azure API Center den här identifieraren, som du kan åsidosätta. Azure-resursnamn för distributionen.
    Beskrivning Du kan också ange en beskrivning. Beskrivning av distributionen.
    Miljö Gör ett val i listrutan, till exempel Min testning, eller välj Skapa ny. Ny eller befintlig miljö där API-versionen distribueras.
    Definition Välj eller lägg till en definitionsfil för en version av konferens-API:et. API-definitionsfil.
    Körnings-URL Ange en bas-URL, till exempel https://api.contoso.com. Grundläggande körnings-URL för API:et i miljön.
    Verksamhetsrad Om du har lagt till dessa anpassade metadata kan du välja att göra ett val från listrutan, till exempel IT. Anpassade metadata som identifierar affärsenheten som hanterar API:er i miljön.

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

  6. Välj Skapa. Distributionen visas i listan över distributioner.

I den här självstudien har du lärt dig hur du använder portalen för att:

  • Lägga till information om API-miljöer
  • Lägga till information om API-distributioner

Relaterat innehåll