Was sind die besten Praktiken für die Root-Seite eines REST-API?
https://stackoverflow.com/questions/2894723
-
04-10-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianFrage
Ich würde gerne wissen, ob es gibt einige bewährten Methoden über den Root-Endpunkt für einen Web-Service REST? Ich meine, es sollte eine kurze Dokumentation über die Nutzung der API selbst sein? Sollte es sich um ein XML-Dokument beschreibt alle Methoden zur Verfügung stehen? Sollte es nur „unbekannte Methode“ zurückgeben?
Lösung
Diese Frage gestellt wird, ist unklar. Ich würde vermuten, es bedeutet so etwas wie ein Verzeichnis, dass alle API-Methoden unter sind. Zum Beispiel wäre das Stammverzeichnis der Flickr-API http://api.flickr.com/services / rest / .
Ein Beispiel für ein Projekt, das die Flickr-API zugreift, finden Sie unter python-flickrapi
Andere Tipps
Die Frage ist ganz klar für mich.
Ich denke, es sollte mit 404. antworten Wenn es keine Ressource mit dem Root-Pfad zugeordnet ist, dann gibt es nichts zurück.
Wenn Sie das Gefühl, dass 404 nicht hilfreich sind, dann wäre es auch in Ordnung sein, um die URL der Dokumentation zurückzukehren.
1. NerdDinner verwendet WCF Data Services, die eine gute Möglichkeit ist, um richtig RESTful Dienste zu implementieren. Der Grund, warum ich bin Punkt, dass, und nicht die WCF-Datendienste direkt ist, weil es sich um eine öffentliche Website und Sie können es verwenden. 2. MediaWiki ist kein gutes Beispiel, weil sie Aktionen in der URI sind vorbei, aber es ist technisch ein RESTful Service und Show ist eine Menge interessanter Ideen.
der rootend Punkt des REST-API ist die die API für den ersten Schrägstrich heißt definiert „/“ der URL nach dem Dispatcher-Servlet. Es enthält alle GET für die Liste der Ressourcen (vor allem die get für alle Datenbanktabellen) diese Liste weiter alle befinden sich die Elemente und in einzelnen Artikel wird es DELETE, PUT / PATCH und SELF get URL. So macht die Implementierung von HATEOS.
REST soll selbst zu beschreiben, so dass die Wurzel einen Fehler zeigen, die ist schlechtes Design meiner Meinung nach. Ich mag die Wurzel Informationen enthalten, die Sie den Rest der API navigieren können. So zum Beispiel die Wurzel möglicherweise einen Link zu einer Liste von Produktkategorien enthalten, aus denen die API Benutzer eine Kategorie und dann eine Liste von Produkten auswählen können usw. Ein selbstbeschreibende API Mittel weniger Dokumentation zu schreiben und immer wieder aktualisiert !!
