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 Endpoint enthalten also in fast allen Fällen eine oder mehrere Resourcen.

API Blueprint

Die API ist in API Blueprint definiert und wird mit Aglio zu HTML gerendert. Aktuelle und ältere Versionen können hier angesehen werden:

API Version
current 0.16
next develop
deprecated 0.15

Übersicht

Endpoint Beschreibung
/comments Liefert Comments-Resourcen
/events Liefert Event-Resourcen
/friends Liefert Friends-Resourcen
/me Liefert die User-Resource des autorisierten User
/{object}/{id}/comments Liefert Comments-Resourcen zu einem Objekt
/{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
Bearbeiten