Tutorial: Importieren und Veröffentlichen Ihrer ersten APITutorial: Import and publish your first API

In diesem Tutorial wird veranschaulicht, wie Sie eine Back-End-API mit OpenAPI-Spezifikation im JSON-Format in Azure API Management importieren.This tutorial shows how to import an OpenAPI Specification backend API in JSON format into Azure API Management. Microsoft stellt die in diesem Beispiel verwendete Back-End-API bereit und hostet sie in Azure unter 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.

Nachdem Sie die Back-End-API in API Management importiert haben, wird Ihre API Management-API zu einer Fassade für die Back-End-API.Once you import the backend API into API Management, your API Management API becomes a façade for the backend API. Sie können die Fassade an Ihre Anforderungen in API Management anpassen, ohne hierfür die Back-End-API bearbeiten zu müssen.You can customize the façade to your needs in API Management without touching the backend API. Weitere Informationen finden Sie unter Transformieren und Schützen Ihrer API.For more information, see Transform and protect your API.

In diesem Tutorial lernen Sie Folgendes:In this tutorial, you learn how to:

  • Importieren einer API in API ManagementImport an API into API Management
  • Testen der API im Azure-PortalTest the API in the Azure portal

Nach dem Import können Sie die API im Azure-Portal verwalten.After import, you can manage the API in the Azure portal.

Neue API in API Management

VoraussetzungenPrerequisites

Navigieren zur API Management-InstanzGo to your API Management instance

  1. Suchen Sie im Azure-Portal nach API Management-Dienste, und wählen Sie die entsprechende Option aus.In the Azure portal, search for and select API Management services.

    Auswählen von API Management-Dienste

  2. Wählen Sie auf der Seite API Management-Dienste Ihre API Management-Instanz aus.On the API Management services page, select your API Management instance.

    Auswählen Ihrer API Management-Instanz

Importieren und Veröffentlichen einer Back-End-APIImport and publish a backend API

In diesem Abschnitt wird gezeigt, wie Sie eine Back-End-API mit OpenAPI-Spezifikation importieren und veröffentlichen.This section shows how to import and publish an OpenAPI Specification backend API.

  1. Wählen Sie im linken Navigationsbereich der API Management-Instanz APIs aus.In the left navigation of your API Management instance, select APIs.

  2. Wählen Sie die Kachel OpenAPI aus.Select the OpenAPI tile.

  3. Wählen Sie im Fenster Aus OpenAPI-Spezifikation erstellen die Option Vollständig aus.In the Create from OpenAPI specification window, select Full.

  4. Geben Sie die Werte aus der folgenden Tabelle ein.Enter the values from the following table. Wählen Sie Erstellen aus, um die API zu erstellen.Then select Create to create your API.

    Sie können API-Werte während der Erstellung oder später über die Registerkarte Einstellungen festlegen.You can set API values during creation or later by going to the Settings tab.

    Neue API in API Management

    EinstellungSetting WertValue BESCHREIBUNGDescription
    OpenAPI-SpezifikationOpenAPI specification https://conferenceapi.azurewebsites.net?format=jsonhttps://conferenceapi.azurewebsites.net?format=json Der Dienst, der die API implementiert.The service implementing the API. API Management leitet Anfragen an diese Adresse weiter.API Management forwards requests to this address.
    AnzeigenameDisplay name Nachdem Sie die vorherige Dienst-URL eingegeben haben, füllt API Management dieses Feld basierend auf dem JSON-Code aus.After you enter the preceding service URL, API Management fills out this field based on the JSON. Der Name im Entwicklerportal angezeigte Name.The name displayed in the developer portal.
    NameName Nachdem Sie die vorherige Dienst-URL eingegeben haben, füllt API Management dieses Feld basierend auf dem JSON-Code aus.After you enter the preceding service URL, API Management fills out this field based on the JSON. Ein eindeutiger Name für die API.A unique name for the API.
    BeschreibungDescription Nachdem Sie die vorherige Dienst-URL eingegeben haben, füllt API Management dieses Feld basierend auf dem JSON-Code aus.After you enter the preceding service URL, API Management fills out this field based on the JSON. Eine optionale Beschreibung der API.An optional description of the API.
    URL-SchemaURL scheme HTTPSHTTPS Gibt an, welche Protokolle auf die API zugreifen können.Which protocols can access the API.
    API-URL-SuffixAPI URL suffix conferenceconference Das Suffix wird an die Basis-URL für den API Management-Dienst angehängt.The suffix appended to the base URL for the API Management service. API Management unterscheidet APIs anhand des Suffix. Daher muss jede API eines bestimmten Herausgebers ein eindeutiges Suffix haben.API Management distinguishes APIs by their suffix, so the suffix must be unique for every API for a given publisher.
    TagsTags Tags zum Organisieren von APIs für die Suche, Gruppierung oder Filterung.Tags for organizing APIs for searching, grouping, or filtering.
    ProdukteProducts UnbegrenztUnlimited Zuordnung von einer oder mehreren APIs.Association of one or more APIs. Jede API Management-Instanz enthält zwei Beispielprodukte: Starter und Unbegrenzt.Each API Management instance comes with two sample products: Starter and Unlimited. Zur Veröffentlichung einer API muss diese einem Produkt zugeordnet werden (in diesem Beispiel Unbegrenzt).You publish an API by associating the API with a product, Unlimited in this example.

    Sie können ein Produkt mit mehreren APIs versehen und sie Entwicklern über das Entwicklerportal zur Verfügung stellen.You can include several APIs in a product and offer them to developers through the developer portal. Geben Sie den Produktnamen ein, oder wählen Sie ihn aus, um diese API einem anderen Produkt hinzuzufügen.To add this API to another product, type or select the product name. Wiederholen Sie diesen Schritt, um die API mehreren Produkten hinzuzufügen.Repeat this step to add the API to multiple products. Sie können APIs Produkten auch später über die Seite Einstellungen hinzufügen.You can also add APIs to products later from the Settings page.

    Weitere Informationen zu Produkten finden Sie unter Erstellen und Veröffentlichen eines Produkts.For more information about products, see Create and publish a product.
    GatewaysGateways VerwaltetManaged API-Gateways, die die API verfügbar machen.API gateway(s) that expose the API. Dieses Feld ist nur bei Diensten mit Developer- und Premium-Tarif verfügbar.This field is available only in Developer and Premium tier services.

    Verwaltet gibt an, dass das Gateway in den API Management-Dienst integriert ist und von Microsoft in Azure gehostet wird.Managed indicates the gateway built into the API Management service and hosted by Microsoft in Azure. Selbstgehostete Gateways sind nur bei Diensten mit Premium- und Developer-Tarif verfügbar.Self-hosted gateways are available only in the Premium and Developer service tiers. Sie können sie lokal oder in anderen Clouds bereitstellen.You can deploy them on-premises or in other clouds.

    Wenn keine Gateways ausgewählt sind, ist die API nicht verfügbar, und Ihre API-Anforderungen können nicht erfolgreich ausgeführt werden.If no gateways are selected, the API won't be available and your API requests won't succeed.
    Versionsverwaltung für diese API?Version this API? Auswählen bzw. Aufheben der AuswahlSelect or deselect Weitere Informationen finden Sie unter Veröffentlichen mehrerer Versionen Ihrer API.For more information, see Publish multiple versions of your API.

    Hinweis

    Wenn Sie die API für API-Consumer veröffentlichen möchten, müssen Sie sie einem Produkt zuordnen.To publish the API to API consumers, you must associate it with a product.

  5. Klicken Sie auf Erstellen.Select Create.

Falls beim Importieren einer API-Definition Probleme auftreten, helfen Ihnen die Informationen in der Liste mit den bekannten Problemen und Einschränkungen weiter.If you have problems importing an API definition, see the list of known issues and restrictions.

Testen der neuen API im Azure-PortalTest the new API in the Azure portal

Sie können API-Vorgänge direkt über das Azure-Portal aufrufen. Dies ist ein einfacher Weg, die Vorgänge anzuzeigen und zu testen.You can call API operations directly from the Azure portal, which provides a convenient way to view and test the operations.

  1. Wählen Sie im linken Navigationsbereich der API Management-Instanz APIs > Demo Conference API aus.In the left navigation of your API Management instance, select APIs > Demo Conference API.

  2. Wählen Sie die Registerkarte Test und dann GetSpeakers aus.Select the Test tab, and then select GetSpeakers. Auf der Seite werden Abfrageparameter und Header angezeigt (falls zutreffend).The page shows Query parameters and Headers, if any. Ocp-Apim-Subscription-Key wird automatisch für den Abonnementschlüssel eingefügt, der dieser API zugeordnet ist.The Ocp-Apim-Subscription-Key is filled in automatically for the subscription key associated with this API.

  3. Wählen Sie Senden aus.Select Send.

    Neue API in API Management

    Das Back-End antwortet mit 200 OK und einigen Daten.The backend responds with 200 OK and some data.

Nächste SchritteNext steps

In diesem Tutorial haben Sie Folgendes gelernt:In this tutorial, you learned how to:

  • Importieren Ihrer ersten APIImport your first API
  • Testen der API im Azure-PortalTest the API in the Azure portal

Im nächsten Tutorial erfahren Sie, wie Sie ein Produkt erstellen und veröffentlichen:Advance to the next tutorial to learn how to create and publish a product: