Identitäten zuweisen
Geschrieben vonOssi Galkin Vor über einer Woche aktualisiertTable of contentsBenennen von APIs
Da Frends modernste Funktionen zum Erstellen von REST-APIs bereitstellt, wird empfohlen, die bewährten Methoden zur Benennung von REST-APIs zu verwenden.
API-Titel
Ein API-Titel ist der eigentliche Name der API und sollte beschreibend und kurz genug sein und mit „API“ enden. Wenn Sie die URL oder den Basispfad einrichten, legen Sie ihn in der Form /api/IhrTitel/Version fest.
API-Ressourcen
In REST werden die Daten als Singleton oder Sammlungsressource dargestellt.
Die hierarchischen Beziehungen dieser Ressourcen sollten mit einem Schrägstrich (/) gekennzeichnet werden. In URIs sollten keine abschließenden Schrägstriche verwendet werden. Zum Beispiel in:
/api/IhrTitel/Version/übergeordnete Ressource/untergeordnete Ressource
Die Beziehung wird durch Schrägstriche angezeigt und dieKinderressourcehat keinen abschließenden Schrägstrich. Wenn Sie die Lesbarkeit der URIs verbessern möchten, verwenden Sie nur Bindestriche (-) und keine Unterstriche (_). API-Ressourcen sollten außerdem mit Kleinbuchstaben und ohne Dateierweiterungen benannt werden. Wenn HTTP-Methoden in APIs richtig verwendet werden, ist es nicht erforderlich, CRUD-Funktionen in Namen zu verwenden, da diese mit den HTTP-Methoden angegeben werden.
Der nächste Artikel istBewährte Methoden zum Benennen von Elementen und Variablen
Verwandte ArtikelBewährte Methoden zur SicherheitBest Practices zur Benennung von Prozessen und UnterprozessenBewährte Methoden zum Benennen von Elementen und VariablenBest Practices zur Versionierung von APIsEinführung in die Benennung und Versionierung von API-Spezifikationen