Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 1.31 KB

README.md

File metadata and controls

38 lines (25 loc) · 1.31 KB

RESTAPIDocs Examples

These examples were taken from projects mainly using Django Rest Framework and so the JSON responses are often similar to the way in which DRF makes responses.

Where full URLs are provided in responses they will be rendered as if service is running on 'http://testserver/'.

Open Endpoints

Open endpoints require no Authentication.

  • Login : POST /api/login/

Endpoints that require Authentication

Closed endpoints require a valid Token to be included in the header of the request. A Token can be acquired from the Login view above.

Current User related

Each endpoint manipulates or displays information related to the User whose Token is provided with the request:

Account related

Endpoints for viewing and manipulating the Accounts that the Authenticated User has permissions to access.