SO业务编排>> social-media-blog-rest-api>> 返回
项目作者： shreyashc

项目描述 ：
REST API for social media (Blog) built using Django, Django-rest-framework, Postgres.
高级语言： Python
项目地址: git://github.com/shreyashc/social-media-blog-rest-api.git
创建时间： 2020-10-01T10:14:45Z
项目社区：https://github.com/shreyashc/social-media-blog-rest-api
开源协议：MIT License
下载


Social Media/ Blog REST API

(Django,drf,PostgreSQL)

live

https://hcblogapi.herokuapp.com/

Fully fledged rest api for social-media/blog
using Django and Django-rest-framework and
PostgreSQL(ORM).

features:

  • create,read,update,delete Blogs
  • user signup/login/password-update
  • comments
  • likes
  • Token Authentication
  • custom Admin pannel (/admin)
  • search filters
  • pagination
  • …..

TODO:

  • replace defatut tokens with JWTs

setup

  • db configuration

default(sqlLite)

  1.     DATABASES = {
  2.     'default': {
  3.         'ENGINE': 'django.db.backends.sqlite3',
  4.         'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
  5.     }
  6. }

postgres

  1. DATABASES = {
  2.     'default': {
  3.         'ENGINE': 'django.db.backends.postgresql',
  4.         'NAME': 'dbname',
  5.         'USER': 'dbuser',
  6.         'PASSWORD': 'dbpassword',
  7.         'HOST': 'dbhost',
  8.         'PORT': '5432',
  9.     }
  10. }

install

  1.     pip install -r requirements.txt
  2.     python manage.py migrate
  3.     python manage.py runserver

CORS is disabled by default

ROUTES :

signup

  • /signup/
    • method : POST
  1. body
  2. {
  3.     "username": REQUIRED
  4.     "email":  REQUIRED
  5.     "password": REQUIRED
  6.     "bio": OPTIONAL
  7. }
  9. //axios
  11. //request
  12. axios.post('BASE_URL/signup/',{
  13.     username:'shreyas',
  14.     email:'shreyas@gmail.com',
  15.     password:'1@345*hc'
  16. })
  17. .then((res)=>{
  18.     console.log(res.data)
  19. }).catch(err=>{
  20.     console.log(err.response.data)
  21. })
  24. //response
  25. {
  26.   username: 'shreyas',
  27.   email: 'shreyas@gmail.com',
  28.   token: '15892a7a87be9892f42db64b9ed76535c59a0b26'
  29. }
  30. //errors
  31.     {
  32.         username: [ 'This field is required.' ],
  33.         email: [ 'This field is required.' ],
  34.         password: [ 'This field is required.' ]
  35.     },
  37.     {
  38.         username: [ 'username is already taken' ],
  39.         email: [ 'email is already registred' ],
  40.         password: [ 'Ensure this field has at least 8 characters.' ]
  41.     }

login

  • /login/
    • method : POST
  1. //axios
  3. //request
  4. axios
  5.     .post("BASE_URL/login/", {
  6.         username: "shreyas",
  7.         password: "1@345*hc",
  8.     })
  9.     .then((res) => {
  10.         console.log(res.data);
  11.     })
  12.     .catch((err) => {
  13.         console.log(err.response.data);
  14.     });
  16. //response
  17. {
  18.   id: 4,
  19.   username: 'shreyas',
  20.   email: 'shreyas@gmail.com',
  21.   auth_token: 'e66628c5bb784e4b0c3366eecac938e18431ccbd'
  22. }
  24. //errors
  25. {
  26.   username: [ 'This field is required.' ],
  27.   password: [ 'This field is required.' ]
  28. },
  29. {
  30.     [ 'Invalid username/password' ]
  31. }

update profile

  • /update-profile/
    • method : PUT / PATCH
    • Auth : REQUIRED
  1. //axios
  3. //request
  4. axios
  5.     .patch(
  6.         "BASE_URL/update-profile/",
  7.         {
  8.             email: "newEmail@gmail.com",
  9.             bio: "bio update",
  10.         },
  11.         {
  12.             headers: {
  13.                 //Token which you will get after login/signup
  14.                 Authorization: "Token e66628c5bb784e4b0c3366eecac938e18431ccbd",
  15.             },
  16.         }
  17.     )
  18.     .then((res) => {
  19.         console.log(res.data);
  20.     })
  21.     .catch((err) => {
  22.         console.log(err.response.data);
  23.     });
  25. //reponse
  26. {
  27.   message: 'Profile updated successfully',
  28.   data: [ 'email:newEmail@gmail.com', 'bio:bio update' ]
  29. }
  31. //errors
  32. {
  33.     //400
  34.     email: [ 'Enter a valid email address.' ]
  35. },
  36. {
  37.     //401
  38.     detail: 'Authentication credentials were not provided.'
  39. }

change password

  • /change-password/
    • method : PUT / PATCH
    • Auth : REQUIRED
  1. //axios
  3. //request
  4. axios
  5.     .patch(
  6.         "BASE_URL/change-password/",
  7.         {
  8.             old_password: "1@345*hc",
  9.             password1: "qwerty123",
  10.             password2: "qwerty123",
  11.         },
  12.         {
  13.             headers: {
  14.                  //Token which you will get after login/signup
  15.                 Authorization: "Token e66628c5bb784e4b0c3366eecac938e18431ccbd",
  16.             },
  17.         }
  18.     )
  19.     .then((res) => {
  20.         console.log(res.data);
  21.     })
  22.     .catch((err) => {
  23.         console.log(err.response.data);
  24.     });
  26. //response
  27. {
  28.   status: 'success',
  29.   code: 200,
  30.   message: 'Password updated successfully',
  31.   data: []
  32.   //Token remains the same.
  33. }
  35. //errors
  36. {
  37.   old_password: [ 'This field is required.' ],
  38.   password1: [ 'This field is required.' ],
  39.   password2: [ 'This field is required.' ]
  40. },
  41. {
  42.   password1: [ 'Ensure this field has at least 8 characters.' ],
  43.   password2: [ 'Ensure this field has at least 8 characters.' ]
  44. },
  45. {
  46.     old_password: [ 'incorrect password.' ]
  47. }

blogs

Get All Blogs

  • /blogs/
    • method : GET
  2. //fetchApi
  3. //request
  4. fetch('BASE_URL/blogs/', {
  5.   method: 'GET',
  6. })
  7. .then(response => response.json())
  8. .then(data => console.log(data))
  9. .catch(err=>console.log(err))
  12. //axios
  13. //request
  14. axios
  15.     .get("BASE_URL/blogs/")
  16.     .then((res) => {
  17.         console.log(res.data);
  18.     })
  19.     .catch((err) => {
  20.         console.log(err.response.data);
  21.     });
  22. //resopnse
  23. {
  24.   count: 6,
  25.   next: null,
  26.   previous: null,
  27.   results: [
  28.     {
  29.       id: 6,
  30.       author: {
  31.                 "id": 1,
  32.                 "username": "shreyashc"
  33.             },
  34.       title: 'last blog2',
  35.       category: 'pythonlkn',
  36.       description: 'sdafdsfl;',
  37.       content: 'sfdsafdskm',
  38.       thumbnail: 'BASE_URL/media/images/blog_thumbnails/Untitled-1.psd',
  39.       created_at: '2020-09-24T05:38:33.257468Z',
  40.       no_of_likes: 0,
  41.       no_of_comments: 0,
  42.       comment: [],
  43.       likes: []
  44.     },
  45.     {
  46.       id: 5,
  47.       author: {
  48.                 "id": 1,
  49.                 "username": "shreyashc"
  50.             },
  51.       title: 'last blog',
  52.       category: 'python',
  53.       description: 'sdafdsf',
  54.       content: 'sfdsafds',
  55.       thumbnail: 'BASE_URL/media/images/blog_thumbnails/Photo_20200607_153944.jpg',
  56.       created_at: '2020-09-24T05:38:05.107503Z',
  57.       no_of_likes: 0,
  58.       no_of_comments: 0,
  59.       comment: [],
  60.       likes: []
  61.     },
  62.     ......
  63.     ......
  64.     ......

get a single blog

  • /blogs/:id (Int)
    • method : GET
  2. //fetchApi
  3. //request
  4. fetch('BASE_URL/blogs/2', {
  5.   method: 'GET',
  6. })
  7. .then(response => response.json())
  8. .then(data => console.log(data))
  9. .catch(err=>console.log(err))
  12. //axios
  13. //request
  14. axios
  15.     .get("BASE_URL/blogs/2")
  16.     .then((res) => {
  17.         console.log(res.data);
  18.     })
  19.     .catch((err) => {
  20.         console.log(err.response.data);
  21.     });
  23. //response
  24. {
  25.   id: 2,
  26.   author: {
  27.        id: 2, username: 'manu'
  28.        },
  29.   title: 'Android',
  30.   category: 'categeory test',
  31.   description: 'this is a simple description',
  32.   content: "this is content.",
  33.   thumbnail: null,
  34.   created_at: '2020-09-22T06:15:40.646519Z',
  35.   no_of_likes: 2,
  36.   no_of_comments: 1,
  37.   comment: [
  38.             {
  39.             "id": 3,
  40.             "text": "hello",
  41.             "commented_by": {
  42.                 "id": 1,
  43.                 "username": "shreyashc"
  44.             }
  45.         }
  46.             ],
  47.   likes: [
  48.            {
  49.             "id": 2,
  50.             "liked_by": {
  51.                 "id": 1,
  52.                 "username": "shreyashc"
  53.             }
  54.         },
  55.         {
  56.             "id": 3,
  57.             "liked_by": {
  58.                 "id": 2,
  59.                 "username": "manu"
  60.             }
  61.         }
  62.         ]
  63. }

create a blog

  • /blogs/
    • method : POST
    • Auth : REQUIRED
  2. //axios
  3. //request
  4. axios
  5.     .post(
  6.         "BASE_URL/blogs/",
  7.         {
  8.             title: "This is new blog.",
  9.             description: "this is description",
  10.             content: "content goes here",
  11.         },
  12.         {
  13.             headers: {
  14.                  //Token which you will get after login/signup
  15.                 Authorization: "Token e66628c5bb784e4b0c3366eecac938e18431ccbd",
  16.             },
  17.         }
  18.     )
  19.     .then((res) => {
  20.         console.log(res.data);
  21.     })
  22.     .catch((err) => {
  23.         console.log(err.response.data);
  24.     });
  26. //response
  27. {
  28.   id: 7,
  29.   author: { id: 4, username: 'shreyas' },
  30.   title: 'This is new blog.',
  31.   category: null,
  32.   description: 'this is description',
  33.   content: 'content goes here',
  34.   thumbnail: null,
  35.   created_at: '2020-09-26T06:05:45.786195Z',
  36.   no_of_likes: 0,
  37.   no_of_comments: 0,
  38.   comment: [],
  39.   likes: []
  40. }
  42. //errors
  43. {
  44.   title: [ 'This field is required.' ],
  45.   description: [ 'This field is required.' ]
  46. },
  47. {
  48.     detail: 'Authentication credentials were not provided.'
  49.  }

edit a blog

  • /blogs/:blog-id (Int)/
    • method : PUT/ PATCH
    • Auth : REQUIRED
  1. //axios
  3. //request
  4. axios
  5.     .patch(
  6.         "BASE_URL/blogs/7/",
  7.         {
  8.             title: "This is new blod has been editd.",
  9.             category: "fun",
  10.         },
  11.         {
  12.             headers: {
  13.                  //Token which you will get after login/signup
  14.                 Authorization: "Token e66628c5bb784e4b0c3366eecac938e18431ccbd",
  15.             },
  16.         }
  17.     )
  18.     .then((res) => {
  19.         console.log(res.data);
  20.     })
  21.     .catch((err) => {
  22.         console.log(err.response.data);
  23.     });
  25. //response
  26. {
  27.   id: 7,
  28.   author: { id: 4, username: 'shreyas' },
  29.   title: 'This is new blod has been editd.',
  30.   category: 'fun',
  31.   description: 'this is description',
  32.   content: 'content goes here',
  33.   thumbnail: null,
  34.   created_at: '2020-09-26T06:05:45.786195Z',
  35.   no_of_likes: 0,
  36.   no_of_comments: 0,
  37.   comment: [],
  38.   likes: []
  39. }
  41. //errors
  42. {
  43.     detail: 'Authentication credentials were not provided.'
  44.  }

delete a blog

  • /blogs/:blog-id (Int)/
    • method : DELETE
    • Auth : REQUIRED
  1. //axios
  3. //request
  4. axios
  5.     .delete(
  6.         "BASE_URL/blogs/7/",
  8.         {
  9.             headers: {
  10.                 //Token which you will get after login/signup
  11.                 Authorization: "Token e66628c5bb784e4b0c3366eecac938e18431ccbd",
  12.             },
  13.         }
  14.     )
  15.     .then((res) => {
  16.         console.log(res.data);
  17.     })
  18.     .catch((err) => {
  19.         console.log(err.response.data);
  20.     });
  22. //response
  23. 200;
  25. //errors
  26. {
  27.     detail: "Authentication credentials were not provided.";
  28. }

like a blog

  • /likes/
    • method : POST
    • Auth : REQUIRED
  1. //axios
  3. //request
  4. axios
  5.     .post(
  6.         "BASE_URL/likes/",
  7.         {
  8.             post: 1,
  9.         },
  10.         {
  11.             headers: {
  12.                  //Token which you will get after login/signup
  13.                 Authorization: "Token e66628c5bb784e4b0c3366eecac938e18431ccbd",
  14.             },
  15.         }
  16.     )
  17.     .then((res) => {
  18.         console.log(res.data);
  19.     })
  20.     .catch((err) => {
  21.         console.log(err.response.data);
  22.     });
  23. //response
  24. {
  25.   id: 7,
  26.   post: 1,
  27.   liked_by: 4,
  28.   liked_at: '2020-09-26T06:20:08.152535Z'
  29. }
  31. //error
  32. {
  33.     error: 'already liked'
  34. },
  35. {
  36.     detail: "Authentication credentials were not provided.";
  37. }

remove like

  • /likes/:like-id (Int)/
    • method : POST
    • Auth : REQUIRED
  1. //axios
  3. //request
  4. axios
  5.     .delete(
  6.         "BASE_URL/likes/7",
  8.         {
  9.             headers: {
  10.                 //Token which you will get after login/signup
  11.                 Authorization: "Token e66628c5bb784e4b0c3366eecac938e18431ccbd",
  12.             },
  13.         }
  14.     )
  15.     .then((res) => {
  16.         console.log(res.data);
  17.     })
  18.     .catch((err) => {
  19.         console.log(err.response.data);
  20.     });
  21. //response
  22. OK;
  23. //errors
  24. {
  25.     detail: "Authentication credentials were not provided.";
  26. }

comment a blog

  • /comments/
    • method : POST
    • Auth : REQUIRED
  1. //axios
  3. //request
  4. axios
  5.     .post(
  6.         "BASE_URL/comments/",
  7.         {
  8.             post: 1,
  9.             text: "nice post",
  10.         },
  12.         {
  13.             headers: {
  14.                  //Token which you will get after login/signup
  15.                 Authorization: "Token e66628c5bb784e4b0c3366eecac938e18431ccbd",
  16.             },
  17.         }
  18.     )
  19.     .then((res) => {
  20.         console.log(res.data);
  21.     })
  22.     .catch((err) => {
  23.         console.log(err.response.data);
  24.     });
  26. //response
  27. {
  28.   id: 8,
  29.   post: 1,
  30.   text: 'nice post',
  31.   commented_by: 4,
  32.   commented_at: '2020-09-26T06:32:21.983423Z'
  33. }
  35. //errors
  36. {
  37.     detail: "Authentication credentials were not provided.";
  38. }

edit comment

  • /comments/:comment-id(Int)/
    • method : PUT/PATCH
    • Auth : REQUIRED
  1. //axios
  3. //request
  4. axios
  5.     .patch(
  6.         "BASE_URL/comments/8/",
  7.         {
  8.             text: "nice post edited",
  9.         },
  11.         {
  12.             headers: {
  13.                  //Token which you will get after login/signup
  14.                 Authorization: "Token e66628c5bb784e4b0c3366eecac938e18431ccbd",
  15.             },
  16.         }
  17.     )
  18.     .then((res) => {
  19.         console.log(res.data);
  20.     })
  21.     .catch((err) => {
  22.         console.log(err.response.data);
  23.     });
  25. //response
  26. {
  27.   id: 8,
  28.   post: 1,
  29.   text: 'nice post edited',
  30.   commented_by: 4,
  31.   commented_at: '2020-09-26T06:32:21.983423Z'
  32. }
  34. //errors
  35. {
  36.     detail: "Authentication credentials were not provided.";
  37. }

remove comment

  • /comments/:comment-id(Int)/
    • method : PUT/PATCH
    • Auth : REQUIRED
  1. //axios
  3. //request
  4. axios
  5.     .delete(
  6.         "BASE_URL/comments/8/",
  8.         {
  9.             headers: {
  10.                 //Token which you will get after login/signup
  11.                 Authorization: "Token e66628c5bb784e4b0c3366eecac938e18431ccbd",
  12.             },
  13.         }
  14.     )
  15.     .then((res) => {
  16.         console.log(res.data);
  17.     })
  18.     .catch((err) => {
  19.         console.log(err.response.data);
  20.     });
  22. //response
  23. OK;
  25. //errors
  26. {
  27.     detail: "Authentication credentials were not provided.";
  28. }

user

get all users

  • /users/
    • method : GET
  1. //axios
  3. //request
  4. axios
  5.     .get("BASE_URL/users/")
  6.     .then((res) => {
  7.         console.log(res.data);
  8.     })
  9.     .catch((err) => {
  10.         console.log(err.response.data);
  11.     });
  13. //response
  14. {
  15.   count: 6,
  16.   next: null,
  17.   previous: null,
  18.   results: [
  19.     {
  20.       id: 1,
  21.       username: 'shreyashc',
  22.       email: 'shreyashc@gmail.com',
  23.       bio: null
  24.     },
  25.     {
  26.         id: 2,
  27.         username: 'manu',
  28.         email: 'manu@gmail.com',
  29.         bio: null
  30.     },
  31.     {
  32.          id: 3,
  33.          username: 'rahul',
  34.          email: 'rahul@gmail.com',
  35.          bio: null
  36.     },
  37.     {
  38.       id: 4,
  39.       username: 'shreyas',
  40.       email: 'newEmail@gmail.com',
  41.       bio: 'bio update'
  42.     },
  43.     {
  44.       id: 5,
  45.       username: 'shreyasf',
  46.       email: 'shreyas@gmailf.com',
  47.       bio: null
  48.     },
  49.     ...
  50.     ...
  51.     ...
  52.   ]

get a single user

  • /users/user-id (Int)/
    • method : GET
  1. //axios
  3. //request
  4. axios
  5.     .get("BASE_URL/users/3/")
  6.     .then((res) => {
  7.         console.log(res.data);
  8.     })
  9.     .catch((err) => {
  10.         console.log(err.response.data);
  11.     });
  13. //response
  14. {
  15.     id: 3,
  16.     username: "rahul",
  17.     email: "rahul@gmail.com",
  18.     bio: null,
  19. };

pagination

all responses are paginated by default

  1. {
  2.     "count": 21,
  3.     "next": "BASE_URL/comments/?page=2",
  4.     "previous": null,
  5.     "results": [res...]
  6. }

  • count = total results

  • next = next page

  • previous = previous page

  • you can use query param page=page_no get get a specific page.

search blogs

  • /search/?search=blog-title/
    • method : GET

search users

filter blogs by category

  • GET /blogs/?category=category-name

filter blogs by username

  • GET /blogs/?username=user-name

filter blogs by userId

  • GET /blogs/?username=user-id

additional info

Uploading image for thumbnail

  1. axios
  2.     .post("BASE_URL/blogs/",
  3.     {
  4.         //form-data
  5.     },
  6.     {
  7.     headers: {
  8.         Authorization: "Token e66628c5bb784e4b0c3366eecac938e18431ccbd",
  9.         Content-Type: "multipart/form-data"
  10.     },
  11.     })
  12.     .then((res) => {
  13.         console.log(res.data);
  14.     })
  15.     .catch((err) => {
  16.         console.log(err.response.data);
  17.     });