RESTful API Resource Nisting Design: Get/API/Tweets/1/Kommentare oder Get/API/Kommentare? Tweet_id = 1, welches entspricht mehr mit der Spezifikation?

Erholte API -Ressourcenverschachtelung Best Practices: URL -Design für Tweet -Kommentare

Die Verarbeitung von Ressourcenbeziehungen ist bei der Gestaltung einer erholsamen API von entscheidender Bedeutung. Erhalten Sie beispielsweise alle Kommentare unter einem bestimmten Tweet, und das entsprechende URL -Design spiegelt die erholsame Spezifikation wider. In diesem Artikel wird die beiden URL -Designsysteme verglichen und ihre Vor- und Nachteile analysieren.

Angenommen, Sie müssen alle Kommentare tweet_id = 1 erhalten, Schema eins ist GET /api/tweets/1/comments , Schema zwei is GET /api/comments?tweet_id=1 .

Lösung 1: GET /api/tweets/1/comments

Dieses Schema nistet die Ressourcen unter Tweet -Ressourcen, und die URL spiegelt direkt die Zugehörigkeit zwischen Kommentaren und Tweets wider. GET /api/tweets/1/comments drücken die Anforderungsabsicht eindeutig aus: Holen Sie sich alle Kommentare für Tweets mit tweet_id von 1. Dies entspricht dem Konzept, dass Ressourcenpfade Ressourcenhierarchie im Restful -Prinzip darstellen. Wenn Sie einen bestimmten Kommentar erhalten (z. B. comments_id = 1 ), verwenden Sie GET /api/tweets/1/comments/1 .

Lösung 2: GET /api/comments?tweet_id=1

Dieses Schema verwendet den Abfrageparameter tweet_id , um Tweets anzugeben, und die URL ist eher wie Abfragebedingungen für Kommentare als auf den Zugriff auf verschachtelte Ressourcen. Obwohl es auch den Zweck erreichen kann, spiegelt es nicht direkt die direkte Beziehung zwischen Kommentaren und Tweets wider, und der semantische Ausdruck der URL ist relativ schwach. Um Kommentare mit comments_id = 1 müssen Sie GET /api/comments/1 verwenden, was sich als die URL aller Kommentare unter einem bestimmten Tweet unterscheidet und keine Konsistenz hat.

Schlussfolgerung: Plan 1 entspricht eher den erholsamen Spezifikationen

Lösung 1 ( GET /api/tweets/1/comments ) gewinnt mit der Fähigkeit der klareren Ressourcenexpression. Es zeigt intuitiver die Zugehörigkeit zwischen Kommentarressourcen und Tweet -Ressourcen und entspricht den erholsamen Designprinzipien. Wenn Sie die Fehlertoleranz der gelöschten Kommentarressource berücksichtigen müssen, kann Lösung 2 natürlich vorteilhafter sein, da relevante Tweet -Ressourcen weiterhin über tweet_id gefunden werden können. Ohne solche besonderen Bedürfnisse repräsentiert Programm One jedoch erholsame Best Practices. Die Verwendung GET /api/comments/1 allein, um bestimmte Kommentare zu erhalten, ist ebenfalls ein Standard -URL -Design, aber es steht im Widerspruch zu Schema in Bezug auf die URL -Struktur.

Das obige ist der detaillierte Inhalt vonRESTful API Resource Nisting Design: Get/API/Tweets/1/Kommentare oder Get/API/Kommentare? Tweet_id = 1, welches entspricht mehr mit der Spezifikation?. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!