Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
32 lines (26 sloc) 2.38 KB
title keywords tags summary sidebar permalink folder
Endpoint Übersicht
Youthweb-API, Resource, Endpoint
endpoint
Eine Übersicht über alle Endpoints und Resourcen
api_sidebar
api_endpoint_index.html
api

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
[/comments][api_endpoint_comments] Liefert Comments-Resourcen
[/events][api_endpoint_events] Liefert Event-Resourcen
[/friends][api_endpoint_friends] Liefert Friends-Resourcen
[/me][api_endpoint_me] Liefert die User-Resource des autorisierten User
[/{object}/{id}/comments][api_endpoint_object_comments] Liefert Comments-Resourcen zu einem Objekt
[/{object}/{id}/friends][api_endpoint_object_friends] Liefert Friends-Resourcen zu einem Objekt
[/{object}/{id}/posts][api_endpoint_object_posts] Liefert Post-Resourcen zu einem Objekt
[/posts][api_endpoint_posts] Liefert Post-Resourcen
[/stats][api_endpoint_stats] Liefert Statisik-Resourcen
[/users][api_endpoint_users] Liefert User-Resourcen

{% include links.html %}