Kann eine REST-API mehrere Ressourcen als eine einzige zusammengesetzte Ressource zurückgeben?

Ich bin gerade dabei, eine REST-API zu erstellen, und derzeit tritt das folgende Problem auf:

• Fooist die erste Ressource. CRUD-Operationen können über den /foo/URI angewendet werden .
• Barist die zweite Ressource. CRUD-Operationen können über den /bar/URI angewendet werden .
• Jeder Fooist mit Null oder Eins verbunden Bar. Der Grund, warum ich nicht Barals Unterressource von behandle, Fooist, dass dieselbe BarInstanz von mehreren geteilt werden kann Foo. Also dachte ich, es ist besser, statt über eine unabhängige URI darauf zuzugreifen /foo/[id]/bar.

Mein Problem ist, dass in einer erheblichen Anzahl von Fällen auch Clients, die nach einer FooInstanz fragen, an der zugehörigen BarInstanz interessiert sind . Derzeit bedeutet dies, dass sie zwei Abfragen anstelle von einer ausführen müssen. Ich möchte eine Methode vorstellen, mit der beide Objekte mit einer einzigen Abfrage abgerufen werden können, aber ich weiß nicht, wie ich die API dafür modellieren soll. Was ich mir bisher ausgedacht habe:

• Ich könnte einen ähnlichen Abfrageparameter einführen : /foo/[id]?include_bar=true. Das Problem bei diesem Ansatz besteht darin, dass die Ressourcendarstellung (z. B. die JSON-Struktur) der Antwort anders aussehen muss (z. B. ein Container wie z. B. { foo: ..., bar: ... }nur ein serialisierter Foo), wodurch der FooRessourcenendpunkt "heterogen" wird. Ich denke nicht, dass das eine gute Sache ist. Bei der Abfrage /foosollten Clients unabhängig von den Abfrageparametern immer dieselbe Ressourcendarstellung (Struktur) erhalten.
• Eine andere Idee ist die Einführung eines neuen schreibgeschützten Endpunkts, z /fooandbar/[foo-id]. In diesem Fall ist es kein Problem, eine Darstellung wie zurückzugeben { foo: ..., bar: ... }, da es sich dann nur um die "offizielle" Darstellung der fooandbarRessource handelt. Ich weiß jedoch nicht, ob ein solcher Helfer-Endpunkt wirklich RESTful ist (deshalb habe ich im Titel der Frage "can" geschrieben. Natürlich ist es technisch möglich, aber ich weiß nicht, ob es eine gute Idee ist).

Was denkst du? Gibt es noch andere Möglichkeiten?

Eine REST-API der Stufe 3 würde Ihnen einen Foound auch einen Link zurückgeben, der den entsprechenden Wert angibt Bar.

GET /foo/123
<foo id="123">
  ..foo stuff..
  <link rel="bar" uri="/bar/456"/>
</foo>

Sie können Ihrer API dann eine Drilldown-Funktion hinzufügen, die die Navigation von Links ermöglicht.

GET /foo/123?drilldown=bar
<foo id="123">
  ..foo stuff..
  <link rel="bar" uri="/bar/456">
    <bar id="456">
      ..bar stuff...
    </bar>
  </link>
</foo>

Die Drilldown-Funktion würde sich vor den APIs befinden und Antworten abfangen. Es würde die Drilldown-Anrufe tätigen und die Details eingeben, bevor die Antwort an den Anrufer zurückgegeben wird.

Dies ist eine ziemlich häufige Sache in Level 3 REST, da es die Client / Server-Chattiness über langsame http stark reduziert. Das Unternehmen, für das ich arbeite, erstellt eine REST-API der Stufe 3 mit genau dieser Funktion.

Update: Für was es wert ist, hier ist, wie es in JSON aussehen könnte. So würde unsere API es strukturieren. Beachten Sie, dass Sie Ihre Drilldowns verschachteln können, um Links von Links usw. zu ziehen.

GET /foo/123?drilldown=bar

{
  "self": {
    "type": "thing.foo",
    "uri": "/foo/123=?drilldown=bar",
    "href": "http://localhost/api/foo/123?drilldown=bar"
  },
  "links": [
    {
      "rel": "bar",
      "rev": "foo",
      "type": "thing.bar",
      "uri": "/bar/456",
      "href": "http://localhost/api/bar/456"
    }
  ],
  "_bar": [
    {
      "self": {
        "type": "thing.bar",
        "uri": "/bar/456",
        "href": "http://localhost/api/bar/456"
      },
      "links": [
        {
          ..other link..
        },
        {
          ..other link..
        }
      ]
    }
  ]
}

Wenn 95% aller Abfragen Fooso gut wie wollen Bar, geben Sie es einfach innerhalb des FooObjekts zurück, wenn Sie eine anfordern Foo. Fügen Sie einfach eine Eigenschaft bar(oder einen anderen Begriff für die Beziehung) hinzu und platzieren Sie das BarObjekt dort. Wenn die Beziehung nicht existiert, verwenden Sie null.

Ich denke du überdenkst das :)