good-reads/backend

Main Page

info

1. profile get api
   • GET req
     • URL: http://<>/api/accounts/auth/account/get/
     • Authorization: Token <>
   • res
     • code 200: OK
       • name
       • email
       • mylist
         • book_id
         • title
         • author
         • rate
         • thumbnail url
2. my list get api
   • POST req
     • user_id or user_email
   • res
     • book names
3. 인기있는 책 list get api
   • GET req
   • res
     • book names
     • thumbnail img urls
4. 최근 사람들이 읽은 책 list api
   • GET req
   • res
     • book names
     • thumbnail img urls

search

1. GET method search api
   • GET req
     • genre
     • rate
     • ..
   • res
     • book names
     • author names
     • thumbnail imgs
     • book rates

button

1. logout api
   • POST req
     • URL: http://<>/api/accounts/auth/logout/
     • Authorization: Token <>
   • res
     • code 204: no content

Rate or Review

info

1. profile get api
   • GET req
     • URL: http://<>/api/accounts/auth/account/get/
     • Authorization: Token <>
   • res
     • code 200: OK
       • name
       • email
       • mylist
         • book_id
         • title
         • author
         • rate
         • thumbnail url
2. my list get api
   • POST req
     • user_id or user_email
   • res
     • book names
3. book info get api
   • GET req
     • URL: http://<>/api/books/get/details/?book_id=<>
   • res
     • code 200: OK
       • title
       • author
       • intro
       • rate
       • thumbnail
       • img

button

1. review submit api
   • POST req
     • book_id
     • review
   • res
2. rate submit api
   • POST req
     • book_id
     • rate

Search Page

info

1. profile get api
   • GET req
     • URL: http://<>/api/accounts/auth/account/get/
     • Authorization: Token <>
   • res
     • code 200: OK
       • name
       • email
       • mylist
         • book_id
         • title
         • author
         • rate
         • thumbnail url
2. my list get api
   • POST req
     • user_id or user_email
   • res
     • book names
3. book list get api
   • GET req
   • res
     • book titles
     • book thumbnail img urls
     • book authors
     • book rates

search

1. GET method search api
   • GET req
     • genre
     • rate
     • ..
   • res
     • book names
     • author names
     • thumbnail imgs
     • book rates

book list

1. selected book info get api
   • GET req
     • URL: http://<>/api/books/get/details/?book_id=<>
   • res
     • code 200: OK
       • title
       • author
       • intro
       • rate
       • thumbnail
       • img

Detail Page

info

1. profile get api
   • GET req
     • URL: http://<>/api/accounts/auth/account/get/
     • Authorization: Token <>
   • res
     • code 200: OK
       • name
       • email
       • mylist
         • book_id
         • title
         • author
         • rate
         • thumbnail url
2. my list get api
   • POST req
     • user_id or user_email
   • res
     • book names
3. book info get api
   • GET req
     • URL: http://<>/api/books/get/details/?book_id=<>
   • res
     • code 200: OK
       • title
       • author
       • intro
       • rate
       • thumbnail
       • img

my list edit down menu

1. add book in list api
   • PATCH req
     • URL: http://<>/api/accounts/auth/mylist/edit/
     • Authorization: Token <>
       • user_id
       • book_id
       • list_id
   • res
2. create new list api
   • POST req
     • user_id
     • book_id
     • list_name
   • res

SignUp Page

button

1. register info submit api
   • POST req
     • URL: http://<>/api/accounts/auth/register/
       • name
       • email
       • password
   • res
     • code 201: created
2. password change api
   • POST req
     • URL: http://<>/api/accounts/auth/account/update/
     • Authorization: Token <>
       • password
   • res
     • code 200

Login Page

button

1. login info submit api
   • POST req
     • URL: http://<>/api/accounts/auth/login/
       • email
       • password
   • res
     • code 200: OK
       • user_id
       • token

Add New Book

info

1. profile get api
   • GET req
     • URL: http://<>/api/accounts/auth/account/get/
     • Authorization: Token <>
   • res
     • code 200: OK
       • name
       • email
       • mylist
         • book_id
         • title
         • author
         • rate
         • thumbnail url

button

1. book info submit api
   • PUT req
     • URL: http://<>/api/books/register/
     • Authorization: Token <>
       • book title
       • book author
       • book thumbnail img
       • book rate
       • book intro
   • res
     • code 201: created

My Page

button

1. change user info api
   • PATCH req
     • URL: http://<>/api/accounts/auth/account/update/
     • Authorization: Token <>
       • user_email
       • user_name
       • thumbnail img
       • .. (except password)
   • res
     • code 202: Accepted
       • what you changed
2. password change api
   • POST req
     • URL: http://<>/api/accounts/auth/account/update/
     • Authorization: Token <>
       • password
   • res
     • code 200: OK