Eine Übersicht über alle Endpoints und Resourcen

Begriffe

  • Resource: Eine Resource ist die Representation eines Objekts, zum Beispiel eines Users. Eine Resource, die vom Youthweb-Server geliefert wird, hat immer mindestens die Attribute type und id. Der Aufbau einer Resource ist in JSON API spezifiziert.
  • Endpoint: Ein Endpoint ist eine Stelle in der Youthweb-API, mit der Daten ausgetauscht werden. Zum Beispiel liefert der Endpoint /users/123 eine Resource, die den User mit der ID 123 representiert. Die übertragenen Daten an einem Entpoint enthalten also in fast allen Fällen eine oder mehrere Resourcen.

Übersicht

Endpoint Beschreibung
/events Liefert Event-Resourcen
/friends Liefert Friends-Resourcen
/me Liefert die User-Resource des autorisierten User
/{object}/{id}/friends Liefert Friends-Resourcen zu einem Objekt
/{object}/{id}/posts Liefert Post-Resourcen zu einem Objekt
/posts Liefert Post-Resourcen
/stats Liefert Statisik-Resourcen
/users Liefert User-Resourcen
Tags: endpoint
Edit me