7 Best Practices zum Benennen Ihrer API-Endpunkte

Ein API-Endpunkt ist ein Verbindungspunkt zwischen zwei Softwareprogrammen. APIs haben Endpunkte für jede Ressource. Die Endpunkte geben den genauen Standort einer Ressource auf dem Server an.

Wenn eine Clientanwendung Informationen vom Server anfordert, durchläuft sie die API. Dieser greift dann auf die Anfrage zu und verarbeitet eine Antwort des Servers. Die API überträgt dann die angeforderten Informationen vom Endpunkt an die Anwendung.

Ihre API ist effizient, wenn sie effektiv über ihre Endpunkte kommunizieren kann. Es erleichtert Benutzern den Zugriff auf Ressourcen und verbessert die Benutzererfahrung.

Wie funktioniert ein API-Endpunkt?

Integrierte Systeme kommunizieren über APIs. Ein System sendet eine Anfrage an die API, wobei ein Format wie SOAP oder REST verwendet wird. Der Server empfängt die Anfragen und überträgt die Antwort zurück an die API. Der Standort dieser angeforderten Ressource ist der Endpunkt.

Bevor ein Endpunkt eine Anfrage verarbeitet, muss der Client eine URL, Header und einen Body bereitstellen. Die Header enthalten Metadaten zu einer Anfrage und die an den Server gesendeten Body-Details. Ein Server kann sich auch mit einer Datenbank verbinden, auf die API-Methoden zugreifen können.

API-Endpunkte arbeiten normalerweise mit HTTP-Methoden wie GET, DELETE, PATCH oder POST. Die Methoden bestimmen, wie ein Endpunkt verwendet wird. Wenn ein Client eine Anfrage sendet, muss er diese so formulieren, dass sie sowohl die Anfragemethode als auch die URL enthält, zum Beispiel:

GET https://example.com/books/authors

Die Benennung ist schwierig, egal ob es sich um API-Endpunkte, vernetzte Hardwaregeräte oder Funktionen und Variablen handelt. Sie sollten sich über einige Best Practices informieren, mit denen Sie sicherstellen können, dass Ihre API-Endpunkte eine Bereicherung sind.

1. Verwenden Sie einen Schrägstrich

Verwenden Sie immer Schrägstriche, um URI-Ressourcen zu trennen. Schrägstriche helfen auch, die Ressourcenhierarchie anzuzeigen. Das Folgende ist ein Beispiel:

2. Verwenden Sie Substantive, keine Verben

Sie sollten nur Substantive verwenden, um eine Ressource zu benennen. Substantive beschreiben, wofür eine Ressource ist, im Gegensatz zu einem Verb, das beschreibt, was eine Ressource tut. Hier ist ein Beispiel für eine gute und eine schlechte Möglichkeit, die API-Endpunkte zu benennen.

Gute Benennung:

Schlechte Benennung:

http://example.com/api/books

3. Verwenden Sie Substantive im Plural, nicht im Singular

Sie sollten Ihre API-Endpunkte immer im Plural benennen. Dies zeigt einem Benutzer an, dass mehr als eine Ressource auf dem Server vorhanden ist. Die Verwendung eines Substantivs im Singular kann den Benutzer verwirren und denken, dass es nur eine Ressource gibt.

Gute Benennung:

Schlechte Benennung:

http://example.com/api/books/3

4. Verwenden Sie Kleinbuchstaben

Sie sollten alle URLs in Kleinbuchstaben eingeben. Dazu gehören API-Endpunkt-URLs. Hier ist ein Beispiel:

Gute Benennung:

http://example.com/api/Books/3

Schlechte Benennung:

http://example.com/api/books/3

5. Verwenden Sie Bindestriche, um Wörter zu trennen

Verwenden Sie Bindestriche, um zusammengesetzte Wörter zu trennen. Bindestriche führen zu besser lesbaren Sätzen als Camel Case oder Unterstriche. Sie sind auch besser für SEO-Zwecke.

Gute Benennung:

Schlechte Benennung:

6. Fügen Sie keine Dateierweiterungen hinzu

Sie müssen Ihren API-Endpunkten keine Dateierweiterung hinzufügen. Eine Erweiterung wirkt sich zwar nicht auf die Ausgabe aus, erschwert jedoch das Lesen der Ressource. Es macht die Ressource auch weniger flexibel und bricht sie, wenn sich die Erweiterung in der Zukunft ändert.

Gute Benennung:

Schlechte Benennung:

7. Versionierung einbeziehen

Sie sollten Ihre API-Endpunkte immer nach der Version benennen. Dies ist wichtig, wenn Sie größere Änderungen an der API vornehmen. Es hilft, zwischen zwei oder mehr API-Versionen zu unterscheiden, aus denen die Ressource stammt. Sie können die Version am Anfang des Endpunkts angeben.

Zum Beispiel:

Warum API Best Practices in Betracht ziehen?

APIs sind zum Rückgrat der modernen Programmierung geworden. Sie verbessern die Zusammenarbeit, fördern Innovationen und erhöhen die Anwendungssicherheit.

Unabhängig davon, ob Sie neue Tools verwenden oder vorhandene verwalten, APIs vereinfachen den Prozess. Daher ist es wichtig, Endpunkte zu haben, die die Benutzererfahrung verbessern. Die Benennung und Struktur Ihrer API-Endpunkte bestimmen die Leistung Ihrer API.

Stellen Sie sicher, dass Sie Best Practices verwenden, um effiziente API-Endpunkte zu erstellen.