Api Documentation

Implementation Notes :

You can use it to create a new user to use services.

Parameters :

Parameter	Description	Parameter Type	Data Type
username	Username of your account	Body	String
email	Email linked to your account	Body	String
first_name	Your First Name	Body	String
last_name	Your Last Name	Body	String
password	Your Password	Body	String
password2	Your Password, should match to password	Body	String

Response Class (Status 200):

{

"token": "1a1fe5f57320f66bc2a3a1181d6d4b2dd415fb84",

"response": "Successful Resgister new User"

}

Implementation Notes :

To get Token for a user to authenticate.

Parameters :

Parameter	Description	Parameter Type	Data Type
username	Username of your account	Body	String
password	Your Password	Body	String

Response Class (Status 200):

{

"token": "1a1fe5f57320f66bc2a3a1181d6d4b2dd415fb84",

}

Implementation Notes :

To get List of all Users.

Parameters :

No parameter required

Response Class (Status 200):

[

{

"url": "http://saurabh-rest-django.herokuapp.com/users/1/",

"id": 1,

"username": saurabh1,

"snippets": [

"http://saurabh-rest-django.herokuapp.com/snippets/1/"

]

}

{

"url": "http://saurabh-rest-django.herokuapp.com/users/1/",

"id": 1,

"username": saurabh1,

"snippets": [

"http://saurabh-rest-django.herokuapp.com/snippets/1/"

]

}

]

Implementation Notes :

To get User details.

Parameters :

No parameter required

Response Class (Status 200):

{

"url": "http://saurabh-rest-django.herokuapp.com/users/1/",

"id": 1,

"username": saurabh1,

"snippets": [

"http://saurabh-rest-django.herokuapp.com/snippets/1/"

]

}

Implementation Notes :

To get List of all Snippets.

Parameters :

No parameter required

Response Class (Status 200):

[

{

"url": "http://saurabh-rest-django.herokuapp.com/snippets/1/",

"id": 1,

"highlight": "http://saurabh-rest-django.herokuapp.com/snippets/1/highlight/",

"owner": "saurabh1",

"title": "",

"code": "print(\"Hello World\")",

"linenos": false,

"language": "python",

"style": "friendly"

}

{

"url": "http://saurabh-rest-django.herokuapp.com/snippets/2/",

"id": 2,

"highlight": "http://saurabh-rest-django.herokuapp.com/snippets/2/highlight/",

"owner": "saurabh1",

"title": "",

"code": "print(\"Hello World\")",

"linenos": false,

"language": "python",

"style": "friendly"

}

]

Implementation Notes :

To Post New Snippet Data.

Parameters :

Parameter	Description	Parameter Type	Data Type
Authorization	Token { Get your Token first }	Header	String
title	Title for your snippet	Body	String
code	Code that you want to store	Body	String
language	Computer Language {default : Python}	Body	String
style	Suitable Style { default : friendly }	Body	String

Response Class (Status 200):

{

"url": "http://saurabh-rest-django.herokuapp.com/snippets/1/",

"id": 1,

"highlight": "http://saurabh-rest-django.herokuapp.com/snippets/1/highlight/",

"owner": "saurabh1",

"title": "",

"code": "print(\"Hello World\")",

"linenos": false,

"language": "python",

"style": "friendly"

}

Implementation Notes :

To get Token for a user to authenticate.

Parameters :

No parameter required

Response Class (Status 200):

{

"url": "http://saurabh-rest-django.herokuapp.com/snippets/1/",

"id": 1,

"highlight": "http://saurabh-rest-django.herokuapp.com/snippets/1/highlight/",

"owner": "saurabh1",

"title": "",

"code": "print(\"Hello World\")",

"linenos": false,

"language": "python",

"style": "friendly"

}

Implementation Notes :

To Post New Snippet Data.

Parameters :

Parameter	Description	Parameter Type	Data Type
Authorization	Token { Get your Token first }	Header	String
title	Title for your snippet	Body	String
code	Code that you want to store	Body	String
language	Computer Language {default : Python}	Body	String
style	Suitable Style { default : friendly }	Body	String

Response Class (Status 200):

{

"url": "http://saurabh-rest-django.herokuapp.com/snippets/1/",

"id": 1,

"highlight": "http://saurabh-rest-django.herokuapp.com/snippets/1/highlight/",

"owner": "saurabh1",

"title": "",

"code": "print(\"Hello World\")",

"linenos": false,

"language": "python",

"style": "friendly"

}

Implementation Notes :

To Post New Snippet Data.

Parameters :

Parameter	Description	Parameter Type	Data Type
Authorization	Token { Get your Token first }	Header	String
title	Title for your snippet	Body	String
code	Code that you want to store	Body	String
language	Computer Language {default : Python}	Body	String
style	Suitable Style { default : friendly }	Body	String

Response Class (Status 200):

{

"url": "http://saurabh-rest-django.herokuapp.com/snippets/1/",

"id": 1,

"highlight": "http://saurabh-rest-django.herokuapp.com/snippets/1/highlight/",

"owner": "saurabh1",

"title": "",

"code": "print(\"Hello World\")",

"linenos": false,

"language": "python",

"style": "friendly"

}

Implementation Notes :

To get Token for a user to authenticate.

Parameters :

No parameter required

Response Class (Status 200):

{

}