Importieren und Veröffentlichen Ihrer ersten APIImport and publish your first API

In diesem Tutorial erfahren Sie, wie Sie eine Back-End-API mit OpenAPI-Spezifikation aus https://conferenceapi.azurewebsites.net?format=json importieren.This tutorial shows how to import an "OpenAPI specification" backend API residing at https://conferenceapi.azurewebsites.net?format=json. Diese Back-End-API wird von Microsoft bereitgestellt und in Azure gehostet.This backend API is provided by Microsoft and hosted on Azure.

Nachdem die Back-End-API in API Management (APIM) importiert wurde, wird die APIM-API zur Fassade für die Back-End-API.Once the backend API is imported into API Management (APIM), the APIM API becomes a facade for the backend API. Zum Zeitpunkt des Imports der Back-End-API sind die Quell-API und die APIM-API identisch.At the time you import the backend API, both the source API and the APIM API are identical. APIM ermöglicht Ihnen das Anpassen der Fassade gemäß Ihren Anforderungen, ohne die Back-End-API ändern zu müssen.APIM enables you to customize the facade according to your needs 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 Ihrer ersten APIImport your first API
  • Testen der API im Azure-PortalTest the API in the Azure portal
  • Testen der API im EntwicklerportalTest the API in the Developer portal

Neue API

VoraussetzungenPrerequisites

Navigieren zur API Management-InstanzGo to your API Management instance

Navigieren zur API Management-Instanz

  1. Melden Sie sich beim Azure-Portal an.Sign in to the Azure portal.

  2. Wählen Sie Alle Dienste aus.Select All services.

  3. Geben Sie im Suchfeld api managementein.In the search box, enter api management.

  4. Klicken Sie in den Suchergebnissen auf API Management-Dienste.In the search results, select API Management services.

  5. Wählen Sie Ihre API Management-Dienstinstanz aus.Select your API Management service instance.

Tipp

Klicken Sie auf den Stern, um API Management zu Ihren Favoriten im Azure-Portal hinzuzufügen.To add API Management to your favorites in the Azure portal, select the star.

Das API Management-Symbol (The API Management icon (API Management-Symbol) wird nun im linken Menü im Portal angezeigt.) now appears in the left menu in the portal.

Importieren und Veröffentlichen einer Back-End-API Import 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 unter API MANAGEMENT die Option APIs aus.Select APIs from under API MANAGEMENT.

  2. Wählen Sie OpenAPI-Spezifikation in der Liste aus, und klicken Sie im Popupfenster auf Vollständig.Select OpenAPI specification from the list and click Full in the pop-up.

    Erstellen einer API

    Sie können die API-Werte während der Erstellung oder später über die Registerkarte Einstellungen festlegen. Der rote Stern neben einem Feld gibt an, dass das Feld erforderlich ist.You can set the API values during creation or later by going to the Settings tab. The red star next to a field indicates that the field is required.

    Verwenden Sie die Werte aus der Datei unten, um Ihre erste API zu erstellen.Use the values from the table below to create your first API.

    EinstellungSetting WertValue BESCHREIBUNGDescription
    OpenAPI-SpezifikationOpenAPI Specification https://conferenceapi.azurewebsites.net?format=json Verweist auf den Dienst zum Implementieren der API.References the service implementing the API. API Management leitet Anfragen an diese Adresse weiter.API management forwards requests to this address.
    AnzeigenameDisplay name Demo Conference APIDemo Conference API Wenn Sie nach dem Eingeben der Dienst-URL die TAB-TASTE drücken, wird dieses Feld von APIM basierend auf den Daten in der JSON-Datei ausgefüllt.If you press tab after entering the service URL, APIM will fill out this field based on what is in the json.
    Dieser Name wird im Entwicklerportal angezeigt.This name is displayed in the Developer portal.
    NameName demo-conference-apidemo-conference-api Stellt einen eindeutigen Namen für die API bereit.Provides a unique name for the API.
    Wenn Sie nach dem Eingeben der Dienst-URL die TAB-TASTE drücken, wird dieses Feld von APIM basierend auf den Daten in der JSON-Datei ausgefüllt.If you press tab after entering the service URL, APIM will fill out this field based on what is in the json.
    BeschreibungDescription Geben Sie eine optionale Beschreibung der API an.Provide an optional description of the API. Wenn Sie nach dem Eingeben der Dienst-URL die TAB-TASTE drücken, wird dieses Feld von APIM basierend auf den Daten in der JSON-Datei ausgefüllt.If you press tab after entering the service URL, APIM will fill out this field based on what is in the json.
    URL-SchemaURL scheme HTTPSHTTPS Legt fest, welche Protokolle für den Zugriff auf die API verwendet werden können.Determines which protocols can be used to 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 is appended to the base URL for the API management service. API Management unterscheidet APIs durch deren Suffix. Daher muss jede API eines bestimmten Herausgebers ein eindeutiges Suffix haben.API Management distinguishes APIs by their suffix and therefore the suffix must be unique for every API for a given publisher.
    ProdukteProducts UnbegrenztUnlimited Bei Produkten handelt es sich um API-Zuordnungen.Products are associations of one or more APIs. Sie können ein Produkt mit einer Reihe von APIs versehen und sie Entwicklern über das Entwicklerportal zur Verfügung stellen.You can include a number of APIs into a Product and offer them to developers through the developer portal.
    Zur Veröffentlichung einer API muss diese einem Produkt (in diesem Beispiel: Unbegrenzt) zugeordnet werden.You publish the API by associating the API with a product (in this example, Unlimited). Wenn Sie diese neue API einem Produkt hinzufügen möchten, geben Sie den Produktnamen ein. (Dieser Schritt kann auch später auf der Seite Einstellungen ausgeführt werden.)To add this new API to a product, type the product name (you can also do it later from the Settings page). Dieser Schritt kann mehrfach wiederholt werden, um die API mehreren Produkten hinzuzufügen.This step can be repeated multiple times to add the API to multiple products.
    Entwickler müssen ein Produkt zunächst abonnieren, um Zugriff auf die API zu erhalten.To get access to the API, developers must first subscribe to a product. Wenn sie ein Produkt abonnieren, erhalten sie einen Abonnementschlüssel, der für jede API in diesem Produkt gilt.When they subscribe, they get a subscription key that is good for any API in that product.
    Wenn Sie die APIM-Instanz erstellt haben, sind Sie bereits Administrator und haben somit alle Produkte abonniert.If you created the APIM instance, you are an administrator already, so you are subscribed to every product.
    Standardmäßig enthält jede API Management-Instanz zwei Beispielprodukte: Starter und Unbegrenzt.By default, each API Management instance comes with two sample products: Starter and Unlimited.
    TagsTags Tags zum Organisieren von APIs.Tags for organizing APIs. Tags können zum Suchen, Gruppieren oder Filtern verwendet werden.Tags can be used for searching, grouping, or filtering.
    Versionsverwaltung für diese API?Version this API? Weitere Informationen zur Versionsverwaltung finden Sie unter Veröffentlichen mehrerer Versionen Ihrer API.For more information about versioning, see Publish multiple versions of your API

    Hinweis

    Zur Veröffentlichung der API muss sie einem Produkt zugeordnet werden.To publish the API, you must associate it with a product. Dies ist auf der Seite Einstellungen möglich.You can do it from the Settings page.

  3. Klicken Sie auf Erstellen.Select Create.

Tipp

Sollten beim Importieren Ihrer eigenen API-Definition Probleme auftreten, sehen Sie sich die Liste mit bekannten Problemen und Einschränkungen an.If you are experiencing problems with import of your own API definition, see the list of known issues and restrictions.

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

Testen der API

Vorgänge können direkt aus dem Azure-Portal aufgerufen werden. Dies ist ein einfacher Weg, die Vorgänge einer API anzuzeigen und zu testen.Operations can be called directly from the Azure portal, which provides a convenient way to view and test the operations of an API.

  1. Wählen Sie die API aus, die Sie im vorherigen Schritt erstellt haben (auf der Registerkarte APIs).Select the API you created in the previous step (from the APIs tab).

  2. Wählen Sie die Registerkarte Testen aus.Press the Test tab.

  3. Klicken Sie auf GetSpeakers.Click on GetSpeakers. Auf der Seite werden Felder für Abfrageparameter angezeigt (in diesem Fall keine) sowie Header.The page displays fields for query parameters, in this case none, and headers. Einer der Header ist „Ocp-Apim-Subscription-Key“. Er steht für den Abonnementschlüssel des Produkts, das dieser API zugeordnet ist.One of the headers is "Ocp-Apim-Subscription-Key", for the subscription key of the product that is associated with this API. Der Schlüssel wird automatisch eingefügt.The key is filled in automatically.

  4. Klicken Sie auf Senden.Press Send.

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

Aufrufen einer Operation aus dem Entwicklerportal Call an operation from the developer portal

Vorgänge können auch über das Entwicklerportal aufgerufen werden, um APIs zu testen.Operations can also be called from the Developer portal to test APIs.

  1. Navigieren Sie zum Entwicklerportal.Navigate to the Developer portal.

    Entwicklerportal

  2. Wählen Sie APIS aus, klicken Sie auf Demo Conference API und dann auf GetSpeakers.Select APIS, click on Demo Conference API and then GetSpeakers.

    Auf der Seite werden Felder für Abfrageparameter angezeigt (in diesem Fall keine) sowie Header.The page displays fields for query parameters, in this case none, and headers. Einer der Header ist „Ocp-Apim-Subscription-Key“. Er steht für den Abonnementschlüssel des Produkts, das dieser API zugeordnet ist.One of the headers is "Ocp-Apim-Subscription-Key", for the subscription key of the product that is associated with this API. Wenn Sie die APIM-Instanz erstellt haben, sind Sie bereits Administrator, sodass der Schlüssel automatisch eingetragen wird.If you created the APIM instance, you are an administrator already, so the key is filled in automatically.

  3. Wählen Sie Ausprobieren.Press Try it.

  4. Klicken Sie auf Senden.Press Send.

    Nach dem Aufrufen eines Vorgangs werden im Entwicklerportal die Antworten angezeigt.After an operation is invoked, the developer portal shows the responses.

Nächste Schritte Next 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
  • Testen der API im EntwicklerportalTest the API in the Developer portal

Fahren Sie mit dem nächsten Tutorial fort:Advance to the next tutorial: