Ich würde gerne wissen, ob es einige Best Practices für den Root-Endpunkt für einen REST-Web-Service gibt? Ich meine, sollte es eine kurze Dokumentation über die Verwendung der API selbst sein? Sollte es ein XML-Dokument sein, das alle verfügbaren Methoden beschreibt? Sollte es nur "unbekannte Methode" zurückgeben?Welche Best Practices gelten für die Stammseite einer REST-API?
Diese Frage ist unklar. Ich denke, es bedeutet so etwas wie ein Verzeichnis, unter dem alle API-Methoden liegen. Beispielsweise wäre das Stammverzeichnis der Flickr-API http://api.flickr.com/services/rest/.
Ein Beispiel für ein Projekt, das die Flickr API zugreift, siehe python-flickrapi
ich meine auf der anderen Seite ... eine Ansicht von dem, wie die Dateien aussehen, um die flickr api von einer Web-App zu rufen ... – adam
Der Ausgangspunkt der REST-API ist die für den ersten Schrägstrich definierte API, d. H. "/" Der URL nach dem Dispatcher-Servlet. Es enthält alle GET für die Liste der Ressourcen (meistens die get für alle Datenbanktabellen), diese Liste enthält weiterhin alle Elemente und in einem einzelnen Element werden DELETE, PUT/PATCH und SELF get URL angezeigt. So machen Sie die Implementierung von HATEOS.
Die Frage ist mir vollkommen klar.
Ich denke, es sollte mit 404 reagieren. Wenn dem Stammpfad keine Ressource zugeordnet ist, gibt es nichts zurückzugeben.
Wenn Sie glauben, dass 404 nicht hilfreich ist, dann ist es auch OK, die URL der Dokumentation zurückzugeben.
das ist eine schlecht definierte Frage! bitte geben Sie weitere Details an –