In der Webservicebranche sind „API URIs“ und „API-URLs“ zwei synonym verwendete Begriffe. Trotz der sehr geringen technischen Unterschiede werden die beiden Begriffe von vielen als ein und demselben Begriff angesehen – selbst ihre Grundstrukturen bestehen aus denselben Komponenten.
Es gibt so viele verschiedene Akronyme, die eine Vielzahl von Begriffen in der Computerwelt beschreiben, dass es nie wichtiger war, jeden einzelnen davon zu kennen und zu verstehen. Wenn Sie jemand fragt, was der Unterschied zwischen einer API URI und einer API-URL ist, können Sie ihm sofort antworten?
Bevor wir die beiden zuvor erwähnten API-Begriffe (Application Programming Interface) vergleichen, wollen wir uns jeden einzelnen genauer ansehen.
Was ist eine API URI?
Ein API URI (Uniform Resource Identifier) ist eine spezifische Adresse, die erforderlich ist, um Ressourcen innerhalb einer bestimmten API zu finden und mit ihnen zu interagieren. Mit anderen Worten ist es die eindeutige Adresse für eine bestimmte Information, die innerhalb der API zu finden ist.
Zusammensetzung einer API URI
- Protokoll: Ein Protokoll gibt an, wie mit der API kommuniziert wird, normalerweise HTTP (Hypertext Transfer Protocol) oder HTTPS (sicheres HTTP). Beispielsweisehttps://inhttps://api.example.com/users.
- Host: Der Host kann den Server identifizieren, auf dem sich die API befindet, wieapi.example.comim obigen Beispiel.
- Pfad: Der Pfad gibt eine bestimmte Ressource innerhalb der API an und beginnt häufig mit einem Schrägstrich (/). Ein Pfad wie/userskönnte beispielsweise auf eine Sammlung von Benutzerdaten verweisen. Manchmal identifizieren Pfadkomponenten außerdem bestimmte Elemente innerhalb der Ressource, beispielsweise/users/123für einen Benutzer mit der ID 123.
- Abfragezeichenfolge (optional): Abfragezeichenfolgen bieten zusätzliche Parameter zum Filtern oder Verfeinern der Ressource. Sie folgen normalerweise einem Fragezeichen (?) und bestehen aus Schlüssel-Wert-Paaren, die durch Et-Zeichen (&) getrennt sind. Beispielsweise/users?name=Johnkönnten Benutzer mit dem Namen John abgerufen werden.
Beispiel für eine API URI
Hier sind einige Beispiele für API URIs in verschiedenen Szenarien mit Beschreibungen, die erklären, was passiert:
- Abrufen aller Benutzer in einem System:
https://api.example.com/users (mithilfe des HTTPS-Protokolls, Zugriff auf die Ressource „Benutzer“ auf „api.example.com“) - Abrufen der Details eines bestimmten Benutzers mit der ID 123:
https://api.example.com/users/123 (Zugriff auf den Benutzer mit der ID 123 innerhalb der Ressource „Benutzer“) - Suche nach Benutzern mit dem Namen „John“:
https://api.example.com/users?name=John (mithilfe eines Abfrageparameters zum Filtern nach Namen)
Nachdem nun klarer ist, was eine API URI ist, fahren wir mit den API-URLs fort!
Was ist eine API-URL?
Eine API-URL (Uniform Resource Locator) ist die spezifische Adresse, die von Webentwicklern verwendet wird, um auf bestimmte Daten oder Funktionen innerhalb einer API zuzugreifen und mit diesen zu interagieren.
Aus praktischen Gründen können Sie sich API-URLs im Wesentlichen als dasselbe wie eine API URI vorstellen. Beachten Sie jedoch, dass es zwischen URIs und URLs einige kleine Unterschiede gibt, auf die wir im folgenden Artikel hinweisen werden.
API-URLs folgen derselben Struktur wie eine API URI, wo Sie ein Protokoll, einen Host, einen Pfad und eine optionale Abfragezeichenfolge finden können.
Interessante Hinweise zu API-URLs
Beim Thema API-URLs sind noch einige weitere Punkte zu beachten, beispielsweise die folgenden:
- URLs dienen eher der Lokalisierung von Ressourcen.
- Die beiden Begriffe API URLund API Endpointwerden oft synonym verwendet . Endpunkte sind bestimmte Aktionen oder Ressourcen, auf die Sie innerhalb einer API zugreifen können und deren Standort normalerweise durch die API-URL definiert wird.
- Anfragen werden an API-URLs gesendet. Daher ist es wichtig zu verstehen, wie API-URLs erstellt und verwendet werden, damit Sie ordnungsgemäß mit APIs interagieren können. Glücklicherweise verfügen die heutigen Programmiersprachen und Bibliotheken über viele integrierte Funktionen, die Ihnen beim Erstellen und Senden von Anfragen helfen.
Beispiele für API-URLs
Hier sind einige Beispiele aus der Praxis für API-URLs, die Sie vielleicht schon einmal gesehen haben, zusammen mit einer kurzen Beschreibung dessen, was passiert:
- GitHub: https://api.github.com/users/Bard (ruft Informationen über den Benutzer „Bard“ ab)
- OpenWeatherMap: https://api.openweathermap.org/data/2.5/weather?q=London (ruft Wetterdaten für London ab)
- Unsplash: https://api.unsplash.com/photos/random?count=1 (ruft ein zufälliges Foto ab)
- Spotify: https://api.spotify.com/v1/tracks/7DIc5T4L54qeJrQ7zfnkzL (ruft Informationen zu einem bestimmten Titel ab)
Erkennen Sie nun, nachdem Sie sich die API URIs und API-URLs angesehen haben, einen eklatanten Unterschied?
Technischer Unterschied zwischen API URIs und API-URLs
Hier ist eine Tabelle, die die winzigen Unterschiede zwischen einer API URI und einer API-URL beschreibt. Die Unterschiede sind recht gering, daher benötigen Sie möglicherweise mehr Zeit, um sich an sie zu gewöhnen.
API URI | API-URL | |
Umfang | Kann ein größeres Spektrum an Kennungen umfassen, darunter Namen, Standorte und beides. | Identifiziert insbesondere den Standort einer Ressource in einem Netzwerk. |
Fokus | Identifiziert eine Ressource, unabhängig von ihrem Zugriffsprotokoll oder ihren Standortdetails. | Stellt das Protokoll, die Serveradresse und den Pfad für den Zugriff auf die Ressource bereit. |
Standortspezifität | Kann ortsunabhängig sein. | Gibt immer den Netzwerkstandort der Ressource an. |
Schemaabhängigkeit | Nicht an ein bestimmtes Protokoll gebunden. | Abhängig von einem Protokoll wie HTTP oder HTTPS. |
Eine Design-First-API-Entwicklungsplattform – Apidog
Apidog ist eine komplette All-in-One-API-Entwicklungsplattform, mit der Entwickler APIs entwerfen, debuggen, testen, dokumentieren und simulieren können. Sie deckt den gesamten API-Lebenszyklus ab – perfekt für Webentwickler, die mal frischen Wind brauchen.
Dank der übersichtlichen und intuitiven Benutzeroberfläche (UI) von Apidog können neue Entwickler schnell lernen, wie sie in den verschiedenen leistungsstarken Funktionen von Apidog navigieren und diese nutzen können.
Importieren Ihrer API-Dateien in Apidog
Wenn Sie über vorhandene APIs verfügen, die Sie sofort bearbeiten oder debuggen möchten, können Sie sie in Apidog importieren!
Wählen Sie einfach den entsprechenden Dateityp aus, der Ihrer API-Datei entspricht. Wenn Sie den genauen Dateityp nicht finden können, ziehen Sie die Datei einfach in den unteren Teil des Fensters, wie im Bild oben gezeigt.
Testen von API-Endpunkten (oder API-URLs) mit Apidog
Wir können testen, ob Ihre API-Endpunkte normal funktionieren, indem wir eine Anfrage mit Apidog senden. Sobald Sie Ihre Dateien in Apidog importiert haben, sollte auf Ihrem Bildschirm etwas Ähnliches wie das folgende Bild angezeigt werden:
Wählen Sie eine der Anfragen Ihrer APIs aus, die auf der rechten Seite des Bildschirms verfügbar sind, wie durch Pfeil 1 angezeigt.
Anschließend können Sie die Anfrage senden, indem Sie auf die Schaltfläche mit dem Pfeil 2 klicken. Stellen Sie dabei jedoch sicher, dass Sie entweder die richtige Umgebung ausgewählt oder die richtige Anfrage-API-URL angegeben haben.
Gehen Sie abschließend zum Abschnitt „Antwort“, um die nach dem Senden der Anfrage erhaltene Antwort anzuzeigen und zu prüfen, ob sie mit der erwarteten Antwort übereinstimmt.
Mehr lesen: So verwenden Sie die Spotify Web API | Einfache Integration mit Spotify
Fazit
API URIs und API-URLs sind strukturell sehr ähnlich, daher betrachten viele sie der Einfachheit halber als dasselbe. Sie sollten sich jedoch der technischen Unterschiede bewusst sein, die beide aufweisen, da sie sich nicht in allen Situationen gegenseitig ersetzen können.
Apidog ist eine API-Entwicklungsplattform mit vollem Funktionsumfang, die die Anforderungen vieler Webentwickler erfüllt. Mit Apidog können Sie APIs entweder als Einzelperson oder im Team debuggen, entwerfen und erstellen.