Självstudie: importera och publicera ditt första APITutorial: Import and publish your first API

Den här självstudien visar hur du importerar ett OpenAPI-API i JSON-format till Azure API Management.This tutorial shows how to import an OpenAPI Specification backend API in JSON format into Azure API Management. Microsoft tillhandahåller Server dels-API: et som används i det här exemplet och är värd för det på Azure på https://conferenceapi.azurewebsites.net?format=json .Microsoft provides the backend API used in this example, and hosts it on Azure at https://conferenceapi.azurewebsites.net?format=json.

När du har importerat Server dels-API: et till API Management blir ditt API Management-API ett fasad för Server dels-API: et.Once you import the backend API into API Management, your API Management API becomes a façade for the backend API. Du kan anpassa fasad efter dina behov i API Management utan att behöva röra Server dels-API: et.You can customize the façade to your needs in API Management without touching the backend API. Mer information finns i Transformera och skydda ditt API.For more information, see Transform and protect your API.

I den här guiden får du lära dig att:In this tutorial, you learn how to:

  • Importera ett API till API ManagementImport an API into API Management
  • Testa API:et i Azure PortalTest the API in the Azure portal

Efter importen kan du hantera API: et i Azure Portal.After import, you can manage the API in the Azure portal.

Nytt API i API Management

FörutsättningarPrerequisites

Gå till API Management-instansenGo to your API Management instance

  1. I Azure Portal du efter och väljer API Management tjänster.In the Azure portal, search for and select API Management services.

    Välj API Management tjänster

  2. På sidan API Management tjänster väljer du din API Management instans.On the API Management services page, select your API Management instance.

    Välj din API Management instans

Importera och publicera ett Server dels-APIImport and publish a backend API

I det här avsnittet visas hur du importerar och publicerar ett OpenAPI-API för-specifikation.This section shows how to import and publish an OpenAPI Specification backend API.

  1. I det vänstra navigerings fönstret på API Management-instansen väljer du API: er.In the left navigation of your API Management instance, select APIs.

  2. Välj panelen openapi .Select the OpenAPI tile.

  3. I fönstret skapa från openapi-specifikation väljer du fullständig.In the Create from OpenAPI specification window, select Full.

  4. Ange värdena från följande tabell.Enter the values from the following table. Välj skapa för att skapa ditt API.Then select Create to create your API.

    Du kan ange API-värden under skapandet eller senare genom att gå till fliken Inställningar .You can set API values during creation or later by going to the Settings tab.

    Skapa ett API

    InställningSetting VärdeValue BeskrivningDescription
    OpenAPI-specifikationOpenAPI specification https: / /conferenceapi.azurewebsites.net? format = JSONhttps://conferenceapi.azurewebsites.net?format=json Tjänsten som implementerar API: et.The service implementing the API. API Management vidarebefordrar begär anden till den här adressen.API Management forwards requests to this address.
    VisningsnamnDisplay name När du har angett föregående tjänst-URL fyller API Management det här fältet baserat på JSON.After you enter the preceding service URL, API Management fills out this field based on the JSON. Namnet som visas i Developer-portalen.The name displayed in the developer portal.
    NamnName När du har angett föregående tjänst-URL fyller API Management det här fältet baserat på JSON.After you enter the preceding service URL, API Management fills out this field based on the JSON. Ett unikt namn för API: et.A unique name for the API.
    BeskrivningDescription När du har angett föregående tjänst-URL fyller API Management det här fältet baserat på JSON.After you enter the preceding service URL, API Management fills out this field based on the JSON. En valfri beskrivning av API: et.An optional description of the API.
    URL-schemaURL scheme HTTPSHTTPS Vilka protokoll som har åtkomst till API: et.Which protocols can access the API.
    API URL-suffixAPI URL suffix konferensconference Suffixet som läggs till i bas-URL: en för API Managements tjänsten.The suffix appended to the base URL for the API Management service. API Management skiljer API: er från deras suffix så att suffixet måste vara unikt för varje-API för en specifik utgivare.API Management distinguishes APIs by their suffix, so the suffix must be unique for every API for a given publisher.
    TaggarTags Taggar för att ordna API: er för sökning, gruppering eller filtrering.Tags for organizing APIs for searching, grouping, or filtering.
    ProdukterProducts ObegränsatUnlimited Associering av en eller flera API: er.Association of one or more APIs. Varje API Management instans levereras med två exempel produkter: starter och obegränsade.Each API Management instance comes with two sample products: Starter and Unlimited. Du publicerar ett API genom att associera API: et med en produkt, obegränsat i det här exemplet.You publish an API by associating the API with a product, Unlimited in this example.

    Du kan inkludera flera API: er i en produkt och erbjuda dem till utvecklare via Developer-portalen.You can include several APIs in a product and offer them to developers through the developer portal. Om du vill lägga till detta API till en annan produkt skriver du eller väljer produkt namnet.To add this API to another product, type or select the product name. Upprepa det här steget om du vill lägga till API: et till flera produkter.Repeat this step to add the API to multiple products. Du kan också lägga till API: er till produkter senare från sidan Inställningar .You can also add APIs to products later from the Settings page.

    Mer information om produkter finns i skapa och publicera en produkt.For more information about products, see Create and publish a product.
    GatewaysGateways HanteradeManaged API-Gateway (er) som exponerar API: et.API gateway(s) that expose the API. Det här fältet är endast tillgängligt i tjänster för utvecklare och Premium -nivån.This field is available only in Developer and Premium tier services.

    Managed anger den gateway som är inbyggd i API Management tjänsten och som finns i Microsoft Azure.Managed indicates the gateway built into the API Management service and hosted by Microsoft in Azure. Gatewayer med egen värd är bara tillgängliga i tjänst nivåerna Premium och Developer.Self-hosted gateways are available only in the Premium and Developer service tiers. Du kan distribuera dem lokalt eller i andra moln.You can deploy them on-premises or in other clouds.

    Om inga gatewayer har valts är API: et inte tillgängligt och API-begärandena lyckas inte.If no gateways are selected, the API won't be available and your API requests won't succeed.
    Vilken är versionen för det här API:et?Version this API? Markera eller avmarkeraSelect or deselect Mer information finns i publicera flera versioner av ditt API.For more information, see Publish multiple versions of your API.

    Anteckning

    Om du vill publicera API: t till API-konsumenter måste du associera det med en produkt.To publish the API to API consumers, you must associate it with a product.

  5. Välj Skapa.Select Create.

Om du har problem med att importera en API-definition kan du läsa listan över kända problem och begränsningar.If you have problems importing an API definition, see the list of known issues and restrictions.

Testa det nya API: et i Azure PortalTest the new API in the Azure portal

Du kan anropa API-åtgärder direkt från Azure Portal, vilket ger ett bekvämt sätt att visa och testa åtgärderna.You can call API operations directly from the Azure portal, which provides a convenient way to view and test the operations.

  1. I det vänstra navigerings fönstret på API Management-instansen väljer du API: er > demo konferens-API.In the left navigation of your API Management instance, select APIs > Demo Conference API.

  2. Välj fliken test och välj sedan GetSpeakers.Select the Test tab, and then select GetSpeakers. Sidan visar frågeparametrar och rubriker, om det finns några.The page shows Query parameters and Headers, if any. OCP-APIM-Subscription-Key fylls i automatiskt för den prenumerations nyckel som är kopplad till detta API.The Ocp-Apim-Subscription-Key is filled in automatically for the subscription key associated with this API.

  3. Välj Skicka.Select Send.

    Test-API i Azure Portal

    Server delen svarar med 200 OK och vissa data.The backend responds with 200 OK and some data.

Nästa stegNext steps

I den här självstudiekursen lärde du dig att:In this tutorial, you learned how to:

  • Importera ditt första APIImport your first API
  • Testa API:et i Azure PortalTest the API in the Azure portal

Gå vidare till nästa självstudie och lär dig hur du skapar och publicerar en produkt:Advance to the next tutorial to learn how to create and publish a product: