26.03.2018

Azure API Management: 3 Wege zur Veröffentlichung

Technical Value

Um eine API zu veröffentlichen gibt es nunmehr drei Möglichkeiten:

  1. Wir erstellen manuell innerhalb des Azure API Managements eine neue API-Definition.
  2. Uns liegt bereits eine API-Definition vor. Dazu werden derzeit die Formate WADL, WSDL und Swagger 2.0 akzeptiert.
  3. Wir haben eine API in Azure als Service veröffentlicht. Die Services „Functions App“, „Logic App“ und „API App“ werden in diesem Fall als Quelle akzeptiert.

In allen drei Fällen musst du zunächst in den Reiter „APIs“ navigieren:

API Veröffentlichung

Unter „Add API“ findest du die drei verschiedenen Auswahlmöglichkeiten:

  • manuell („Blank API“)

oder

  • per API-Definition

oder

  • über einen Azure Service

API veröffentlichen

Der manuelle Weg

Wenn du händisch eine neue API anlegst, dann musst du zunächst einen Anzeigenamen sowie einen internen Namen bestimmen. Idealerweise gibst du auch die URL zur API – sprich: die „Web service URL“ – sowie einen „API URL suffix“ direkt mit an. Letzterer legt fest, unter welchem Endpunkt des Azure API Managements die neu erstellte API erreichbar ist:

API Veröffentlichung

Schließlich werden über „Add operation“ die einzelnen Endpunkte der API definiert. Zu diesem Zweck musst du den HTTP-Request-Type (z.B. GET oder POST), den relativen Pfad des Endpunktes sowie einen Anzeigenamen bestimmen:

API veröffentlichen

Der Weg über API-Definitionen

Am schnellsten und einfachsten lässt sich eine API über das Azure API Management veröffentlichen, wenn bereits API-Definitionen im Swagger-2.0-, WADL- oder WSDL-Format vorliegen. Denn: Durch die Definition werden alle Endpunkte automatisch angelegt. Du musst nur noch die URL, unter der die Definition abrufbar ist, oder die Datei, die die Definition beinhaltet, angeben:

API Veröffentlichung

Anzeigename und interner Name wie auch die „Base URL“ werden daraus automatisch extrahiert. Lediglich den „API URL suffix“ gilt es noch zu setzen.

Der Weg über Azure Services

Handelt es sich bei der API um einen Azure Service, dann kannst du diesen direkt in das Azure API Management einbinden:

API veröffentlichen

Du wählst den entsprechenden Azure Service als API App aus. Wie beim zuvor beschriebenen Lösungsweg werden daraufhin Anzeigename und interner Name sowie die „Base URL“ automatisch generiert. Ebenso solltest du hier den „API URL suffix“ setzen.

Zudem muss innerhalb des Azure Services eine API Definition hinterlegt sein, damit die Endpunkte der API im Azure API Management direkt richtig gesetzt werden. Ist dies nicht der Fall, kannst du Beispiel-Endpunkte für die API über das Azure API Management definieren.

APIs veröffentlichen

Welchen Weg du auch immer gewählt hast: Die API ist nun im Azure API Management angelegt. Nun gilt es, diese zur weiteren Nutzung zu veröffentlichen. Dazu muss die API mindestens einem Produkt zugeordnet werden. Über den Reiter „Produkte“ erstellst du zunächst ein neues Produkt:

API Veröffentlichung

Du vergibst einen Anzeigenamen und einen internen Namen. Zudem wird eine entsprechende Beschreibung ergänzt. Du kannst dann eine beliebige Anzahl an APIs in einem Container zusammenfassen und spezifische Regeln – sogenannte Policies – für die Verwendung festlegen.

Selbstverständlich muss das Produkt veröffentlicht sein, damit Interessenten darauf zugreifen können. Bei einem Abonnement ist keine anonyme Nutzung möglich. Schließlich weist du dem Produkt noch die gewünschte API zu. Produkt und API können daraufhin über das „Developer Portal“ eingesehen, getestet und letztlich in Applikationen verwendet werden.

In meinem nächsten Blogbeitrag zum Azure API Management gehe ich näher auf das Thema „Policies“ ein. Ich werde euch erläutern, welche Regeln es gibt und wie ihr diese einsetzen könnt.

Neuen Kommentar schreiben

Der Inhalt dieses Feldes wird nicht öffentlich zugänglich angezeigt.

Klartext

  • Keine HTML-Tags erlaubt.
  • HTML - Zeilenumbrüche und Absätze werden automatisch erzeugt.
  • Web page addresses and email addresses turn into links automatically.
Teilen auf

Newsletter Anmeldung

Abonnieren Sie unseren Newsletter!
Lassen Sie sich regelmäßig über alle Neuigkeiten rundum ORAYLIS und die BI- & Big-Data-Branche informieren.

Jetzt anmelden