Was eine REST API mit Pizza zu tun hat - Actonic GmbH

Was eine REST API mit Pizza zu tun hat

REST API


5
(1)

Als Consultant gibt es zahlreiche Situationen, in denen Sie mit Entwickler*innen interagieren und eventuell auf Begriffe stoßen, mit denen Sie nicht sonderlich viel anfangen können. Damit Ihre Projekte erfolgreich verlaufen und Sie weiterhin Ihren Kund*innen die beste Beratung liefern können, klären wir heute auf: Was ist eigentlich eine REST API?

5
(1)

Was ist eine API?

API ist eine Abkürzung für Application Programming Interface. Zu Deutsch also: Programmierschnittstelle. Begriff geklärt, doch was steckt dahinter?

Stellen Sie sich eine API am besten als vermittelnde Instanz zwischen den Endverbraucher*innen und den angefragten Ressourcen/Webdiensten dar. Programmierschnittstellen dienen dem standardisierten Austausch von Informationen zwischen Anwendungen und einzelnen Programmteilen, völlig unabhängig ihrer Implementierung. APIs vermitteln Ihre Anfragen an den Server und teilen Ihnen in einer für Sie verständlichen Sprache mit, was die Antwort des Servers war. Sie sind Spezifikationen möglicher Interaktionen mit Software-Komponenten.

Exkurs: HTTP und wie funktioniert das Internet?

Um APIs ganzheitlich zu verstehen, lohnt es sich, ein kleines bisschen weiter auszuholen: beim Internet. Das Internet besteht aus vielen einzelnen Netzwerken (Servern). In ihnen werden Daten gespeichert.

Damit diese Daten auch zu Ihnen und Ihrem Browser gelangen können, wird ein spezielles Protokoll namens HTTP benutzt. Das steht für Hypertext Transfer Protocol. Durch HTTP wird die Struktur von Anfragen und Antworten festgelegt und ein Standard für die Übertragung von Inhalten definiert.

APIs verwenden HTTP, um eine Anfrage an den Server zu senden, woraufhin der Server die Antwort liefert.

API einfach mit Pizza erklärt

Sie haben Hunger und entscheiden, in ein Restaurant zu gehen. Ein aufmerksamer Kellner kommt an Ihren Platz und nimmt Ihre Bestellung auf: „Pizza Margherita”.

„Gibt es die auch vegan?”

Sofern Sie in keinem veganen Restaurant dinieren, ist die Antwort auf diese Frage durchaus offen. Dabei interessieren Sie sich nicht für die Details, ob es gestern noch veganen Käseersatz gab oder in zwei Wochen erst wieder. Sie interessieren sich für eine zeitnahe Antwort auf Ihre akute Anfrage.

Der Kellner kommuniziert mit dem Küchenpersonal, kommt zurück und sagt, dass Sie Ihre vegane Pizza bekommen. Wenig später serviert er Ihnen Ihre vegane Pizza.

Dieser Service ist in etwas das, was eine API tut: Sie liefert genau das, was Sie wollen, in dem Maß, wie es die Küche (das zugrundeliegende System) liefern kann. Überdies müssen Sie nicht alle Einzelheiten des Cachings genau kennen, also wie die Ressourcen abgerufen werden oder woher (in unseren Fall: die sämtlichen Umstände, wie es um die Lagerhaltung, Produktion usw. des veganen Käses bestellt ist. Ja oder Nein genügt als Antwort).

Und die Sprache, in der die Bestellung aufgegeben, angenommen und geliefert wird, ist in diesem Fall HTTP.

Beispiele von APIs

  • PayPal Bezahlung

    • Bestimmt haben Sie über einen Webshop Ihre Bestellung schon einmal mit PayPal bezahlt. Hierbei handelt es sich auch um eine API, die sicherstellt, dass die Endanwendung nur das tut, was sie tun muss, ohne sensible Daten zu verletzen.

  • Schneller Log-in

    • Auf vielen Websites können Sie sich mit einfachen Buttons bei Social Media Kanälen einloggen. Auch an dieser Stelle werden die APIs der Plattformen benutzt, um Sie zu identifizieren.

  • Urlaub buchen

    • Sie wollen das beste Urlaubsschnäppchen schlagen: Internetvergleichsportale bieten eine ideale Übersicht über Abflugzeiten und Preise. Durch APIs können Daten und Anfragen schnell und autonom ausgetauscht werden.

Was ist eine REST API?

Eine REST API ist eine besondere Art der Programmierschnittstelle. REST steht für: Representational State Transfer, einem Architekturstil, der dazu dient, Daten zwischen Nutzer*innen und Anwendungen auszutauschen. Rest ist kein Standard, sondern lediglich ein Architekturdesign, also gewissermaßen eine Sammlung von verschiedenen Protokollen.

REST ist auch kein Protokoll wie HTTP, sondern verwendet das HTTP-Protokoll, um Ressourcen abzurufen und bereitzustellen. Das ist auch einer der Hauptunterschiede von APIs und REST APIs: Je nach Art der API wird ein anderes Protokoll verwendet. REST APIs interagieren ausschließlich über HTTP Protokolle.

Ferner ist die REST Architektur leicht modifizierbar und implementierbar.

Rest API: Genau definiert

Damit eine API eine REST API ist, gibt es einige Kriterien, die erfüllt sein müssen:

  • Client/Server Architektur

    • Das Client-Server-Prinzip folgt dem Prinzip: „Separation of Concerns”. Durch die Trennung verschiedener Belange werden Pflege und Vereinfachung des Codes verbessert.

  • Zustandslosigkeit/Staatenlosigkeit

    • Das bedeutet, dass relevante Sitzungsdaten beim Client und nicht dem Server gespeichert werden. Zustandslose Protokolle steigern die Leistung, da die Serverlast im Vergleich mit der Beibehaltung von Sitzungsinformationen gering gehalten wird.

  • Cachefähigkeit

    • Die Skalierbarkeit der Leistung wird durch gut verwaltetes Caching enorm verbessert. Der Cache kann entweder auf dem Client-Rechner (Arbeitsspeicher) oder im Browser-Speicher ausgeführt werden.

  • Mehrschichtsystem

    • Zwischengeschaltete Server wirken sich nicht auf die Client-Server Kommunikation aus, verbessern jedoch die Skalierbarkeit des Systems sowie die Sicherheitslogik.

  • Code-on-Demand

    • Server können Funktionalitäten eines Clients erweitern, wenn sie den ausführbaren Code übertragen

  • Einheitliche Oberfläche

    • Die einheitliche Oberfläche des REST-Systems vereinfacht die Architektur enorm. Die Ressourcen sind unter Verwendung von URIs konzeptionell getrennt von den Darstellungen, welche der Client enthält.

Vorteile von (REST) APIs

  • APIs ermöglichen eine vereinfachte Programmierung

  • Saubere Gesamtstruktur, da einzelne Funktionen in Programmmodule ausgelagert werden können

  • Agilität durch automatisierte Arbeitsabläufe dank APIs

  • Nahtlose Kommunikation durch die Integration von Plattformen und Systemen

  • REST APIs sind sehr flexibel und lassen sich an jede Änderung der Daten anpassen

  • APIs bieten zusätzlichen Schutz zwischen Daten und Servern

Auch wenn APIs den Umgang mit Datensicherheitsthemen vereinfacht, sollte jedes Unternehmen sicherstellen, dass die verwendeten (Atlassian) Produkte den Datenschutzrichtlinien entsprechen. Gerne werfen wir einen Blick auf Ihre Systeme und Anforderungen und prüfen, ob Sie datenschutzkonform arbeiten oder an welchen Schrauben wir noch gemeinsam drehen können.

Jira REST API

Die Jira Rest APIs sind zum einen für Entwickler*innen gedacht, die Add-ons für Jira Software erstellen und Integrationen zwischen Jira und anderen Anwendungen entwickeln wollen und bieten zum anderen eine Low-Level Möglichkeit, mit dem System zu interagieren.

Jira REST APIs stellen Ressourcen über URI-Pfade zur Verfügung. Das derzeitig unterstützte Antwortformat ist JSON. Methoden sind die standardisierten HTTTP-Methoden wie GET, PUT, POST und DELETE.

Vorteil von der Jira REST API ist, dass sie auf offenen Standards basiert. Das bedeutet, dass jede denkbare Entwicklungssprache verwendet werden kann, um auf sie zuzugreifen.

https://developer.atlassian.com/cloud/jira/platform/images/jira-connect-overview-adg3.png

Atlassian stellt eine detaillierte Jira REST API Dokumentation zur Verfügung, damit Sie genau wissen, wie Sie mit der REST API umgehen können und was es dabei zu beachten gibt. Ebenso finden Sie online im Beispielleitfaden von Jira Server REST APIs oder Beispielleitfaden von Jira Cloud REST APIs tolle Anleitungen zum Erstellen oder Aktualisieren von Vorgängen oder weitgehenden Suchfunktionen.

Fazit REST API und Pizza

Wir hoffen, wir konnten einige Fragezeichen zum Thema (Jira) REST API klären. Denken Sie einfach immer an das Pizza-Beispiel: Sie als Client möchten vom Personal in der Küche (Server) eine Pizza haben. Die Verhandlung findet auf Deutsch (HTTP) statt und folgt bestimmten Richtlinien, etwa der Höflichkeit. Diese Richtlinien, in der die Unterhaltung stattfindet, ist das, was die API tut. Sie sorgt dafür, dass Sie als Kund*in genau die Pizza erhalten, die Sie sich wünschen – sofern die Küche liefern kann.

Falls Sie weitere Fragen haben, stehen wir Ihnen gerne zur Verfügung!

Wie hilfreich war dieser Beitrag?

Klicke auf die Sterne um zu bewerten!

Durchschnittliche Bewertung 5 / 5. Anzahl Bewertungen: 1

Bisher keine Bewertungen! Sei der Erste, der diesen Beitrag bewertet.

Sie möchten
mehr erfahren?

Kontaktieren Sie unsere Experten zur Beantwortung Ihrer individuellen Fragen.

Unverbindlich
anfragen