RESTful verwandte Ressource mit JSONAPI-Schema

Question

Ich verfolge das jsonapi Schema, um eine standardisierte Antwort von einer Web-API zurückzugeben. Ich möchte die Anzahl der HTTP-Anfragen reduzieren, um verwandte Informationen zu erhalten, so dass es aussieht, als ob ich compound documents verwenden möchte, um zum Beispiel einen Artikel und zwei verwandte Kommentare zurückzugeben.

Ich verstehe das etwas, aber ich frage mich, was die RESTful GET Anfrage wäre? Ich denke so etwas wie

http://api.mysite.com/v1/articles/1?comments=2 

Ich möchte explizit sein, aber sind die Anfrage Parameter notwendig, um verwandte Informationen aus einer Ressource zurückgeben?

Answer 1

Ton wie Sie wollen/v1/articles/1? Include = Kommentare & limitComments = 2

Wo limitComments ist eine API-spezifische param (Anmerkung Mitgliedsnamen Anforderungen)

http://jsonapi.org/format/#query-parameters http://jsonapi.org/format/#fetching-includes

Alternativ könnten Sie/v1/Kommentare? Include = Artikel & Filter [Artikel] = 1 & Seite [Größe] = 2

Siehe http://jsonapi.org/recommendations/#filtering und http://jsonapi.org/format/#fetching-pagination