DRF Docs

Document Web APIs made with Django REST Framework.

api/user

Endpoint to receive authorization token, You can authorize through BasicAuth (username/password) or by using this token. Call this URL with username and password as argument. Use the Token like the following in the Authorization Request Header -- 'Authorization': Token <Token_Value>

Fields:

  • username: CharField R
  • password: CharField R

Register a new user

Fields:

  • email: EmailField
  • username: CharField R
  • password: CharField R

Follow a specific user

No fields.

Unfollow a specific user

No fields.

Show specific user with name defined in URL

Fields:

  • id: IntegerField
  • username: SerializerMethodField
  • slogan: CharField
  • website: CharField
  • interests: CharField
  • skills: CharField
  • status: SerializerMethodField
  • groups: ManyRelatedField R
  • followers: SerializerMethodField
  • following: SerializerMethodField

Show and edit current logged in user

Fields:

  • slogan: CharField
  • website: CharField
  • interests: CharField
  • skills: CharField

api/status

Status feed, displaying latest statuses of followed users

Fields:

  • id: IntegerField
  • username: SerializerMethodField
  • message: CharField R
  • created_at: DateTimeField

Post a new status

Fields:

  • message: CharField R

api/shoutout

Shoutout feed, displaying shoutouts from all users

Fields:

  • id: IntegerField
  • username: SerializerMethodField
  • message: CharField R
  • created_at: DateTimeField

Post a new shoutout

Fields:

  • message: CharField R
  • anon: BooleanField

api/groups

Joining a group (exact name has to be provided) - Send passphrase as 'passphrase' when needed

No fields.

Leaving a group (exact name has to be provided)

No fields.

Delete groups, only possible as owners

No fields.

Post a new message in a group

Fields:

  • message: CharField R

See a selection of messages in a group

Fields:

  • id: IntegerField
  • username: SerializerMethodField
  • message: CharField R
  • created_at: DateTimeField

Creating a new group (POST; name has to be unique) or showing group info (GET)

Fields:

  • description: CharField
  • passphrase: CharField

api/message

Send a message to a given user

Fields:

  • to_user: CharField R
  • message: CharField R

Get a list of all unread messages for a user

No fields.

Read a specific message with a given ID/PK

No fields.

Get a conversation with a given user

No fields.

Get all users a given user had conversations with

No fields.

api/finders

Returns about 25 random users (if possible)

No fields.

Search for a username (displays similiar usernames)

No fields.

Search for a group

No fields.

api/kickstarter

Get a list of all supporters with a custom message

No fields.