Importera och publicera ett API
För att API:t ska bli tillgängligt via en API-gateway måste du importera och publicera API:et.
I exemplet med skoförsäljningsföretaget vill NorthWind Shoes kunna välja vilka partner som ska kunna köra frågor mot lagret och se lagernivåer.
Här lär du dig hur du importerar ett API till Azure API Management och hur du gör ett API tillgängligt för klienter.
API
Ett API är ett standardiserat sätt för organisationer att exponera specifika data för potentiella utvecklare eller partner. I den föregående övningen skapade du till exempel API för att dela information om produkter och lager.
Första steget för att göra ett API tillgängligt är att importera API:t i API Management. Sedan kan du:
- Testa ditt API med hjälp av visualiseringsverktygen i API-gatewayen.
- Hantera åtkomst till dina API:er med hjälp av principer.
API-ramverk
Det finns olika API-ramverk och standarder. API Management ger dig flera alternativ för att importera API:er. Inklusive alternativen i följande tabell:
| Typ | Details |
|---|---|
| HTTP | Du kan importera ett HTTP-API med en tom API-definition. Sedan anger du de obligatoriska parametrarna manuellt. |
| WebSocket | Konfigurera direktströmning till en WebSocket-serverdelstjänst. |
| GraphQL | Konfigurera direkt till en GraphQL-serverdelstjänst eller importera ett GraphQL-schema och skapa ett syntetiskt GraphQL-API med anpassade fältlösare. |
| OpenAPI | OpenAPI är en specifikation som dokumenterar alla slutpunkter och åtgärder för RESTful-API:er och alla indata- och utdataparametrar. OpenAPI hette ursprungligen Swagger. |
| WADL | Web Application Description Language är en XML-beskrivning av HTTP-baserade webbtjänster. Det är ett enklare format och enklare än beskrivningsspråket för webbtjänsten. |
| WSDL | Web Service Description Language är en XML-beskrivning av alla nätverkstjänster, inte bara HTTP. |
Du kan också importera API:er från flera Azure-resurser på serverdelen. Alternativen inkluderar de i följande tabell.
| Typ | Details |
|---|---|
| Azure OpenAI-tjänsten | API:er som ger åtkomst till OpenAI:s språkmodeller för uppgifter som innehållsgenerering, sammanfattning, semantisk sökning med mera. |
| Logikapp | Logikappar används för att samordna och automatisera arbetsflöden och integreringar med olika datakällor. |
| App Service | Ett API som finns i en apptjänst i Azure. |
| Funktionsapp | Serverlös kod som kan anropas via utlösare. |
| Containerapp | Serverlösa containrar för mikrotjänster. |
Importera ett API
Det finns flera sätt att importera ett API i Azure API Management.
Om du använder Azure-portalen väljer du API:er och sedan + Lägg till API. Du börjar med att välja den API-typ som du vill importera.
Sedan tillhandahåller du en länk till API-specifikationen som en URL eller fil och ett namn för API:et. Här är ett exempel på en OpenAPI-import.
Azure Portal är inte det mest effektiva verktyget för att importera och konfigurera ett stort antal API:er. När du skalar upp API-hanteringen behöver du andra verktyg, till exempel Azure CLI, Azure Resource Manager eller Bicep-mallar eller Azure PowerShell. Du kan till exempel använda Azure PowerShell-cmdletar för att distribuera API-gatewayer, definiera och konfigurera produkter, importera API:er och hantera användare och prenumerationer.
Visualisera
Du kan använda API-gatewayen som ett sätt att visualisera hur data behandlas via dina importerade API:er. Du kan interagera med datauppsättningar och skicka parametrar via dina API:er.
Om du är administratör kan du visualisera API:er i Azure Portal.
Policyer
Med principer får du kraftfulla funktioner för att ändra beteendet för ett API genom konfiguration. Principer är en samling instruktioner som körs i följd på begäran eller som svar på ett API.
Populära konfigurationer:
- Konvertering från XML till JSON
- Anropsbegränsning för att begränsa antalet inkommande anrop.
- Ange inkommande och utgående rubriker.
Du kan tillämpa olika principer för API:er med hjälp av Azure-portalen. Principer visas på fliken Design.
Du kan också använda fliken Design för att lägga till nya principer.
Produkt
En produkt är en samling API:er. Du kan tilldela API:er till mer än en produkt. Du kanske exempelvis vill ha en produkt, NorthWindShoesPartners, som exponerar två API:er för dina partner:
| Produkt | NorthWindShoesPartners |
|---|---|
| API 1 | Lager |
| API 2 | Planerad |
Du kanske bara vill exponera ett API för dina leverantörer:
| Produkt | NorthWindShoesSuppliers |
|---|---|
| API 1 | Lager |
| API 2 |
Du tilldelar principer så att dina produkter kan ha olika åtkomstregler, användningskvoter och användningsvillkor. Om du vill att dina partner och leverantörer ska ha olika åtkomsträttigheter till API:t Inventering tilldelar du API:t till två olika produkter.
Du kan använda Azure-portalen för att koppla API:er till en produkt.
På flera prisnivåer finns det två standardprodukter: Starter och Unlimited. Produkten Obegränsat är utformad för API-hantering för produktion eftersom den inte har några begränsningar för antal anslutna API:er. Du kan skapa så många nya produkter som du behöver. Starter-produkten har en gräns på fem API-anrop/minut och högst 100 API-anrop/vecka.