API Specifications

API Specifications for SpeechBuddy

• Template adopted from: https://gist.github.com/azagniotov/a4b16faf0febd12efbc6c3d7370383a6

---

User

POST /user/signup/ (creates new user by signing up)

Request

Header

Key	Value	Description
None	None	N/A

Body

{
  "email": "string",
  "password": "string",
  "nickname": "string"
}

Response

Status Code

Code	key of Message	Description
201	None	Successfully created
400	email	missing input value, blank input, invalid email format, length error(✅len<=50), already taken
400	password	missing input value, blank input, length error(✅len>=8)
400	nickname	missing input value, blank input, length error(✅len<=15)

POST /user/validateemail/signup/send/ (sends verification code for signup via email)

Request

Header

Key	Value	Description
None	None	N/A

Body

{
  "email": "string"
}

Response

Status Code

Code	key of Message	Description
200	None	N/A (successfully sent)
400	email	missing input value, blank input, invalid email format, length error(✅len<=50), already taken

POST /user/validateemail/pw/send/ (sends verification code for forgot-pw via email)

Request

Header

Key	Value	Description
None	None	N/A

Body

{
  "email": "string"
}

Response

Status Code

Code	key of Message	Description
200	None	N/A (successfully sent)
400	email	missing input value, blank input, invalid email format, length error(✅len<=50), no such user w/ the email

POST /user/validateemail/signup/accept/ (checks email verification code for signup)

Request

Header

Key	Value	Description
None	None	N/A

Body

{
  "email": "string", // should be automatically set by frontend! not by a user!
  "code": "string"
}

Response

Status Code

Code	key of Message	Description
200	None	N/A (successfully checked)
400	email	missing input value, blank input, invalid email format, length error(✅len<=50)
400	code	missing input value, blank input, length error(✅len==6)
400	fail	wrong code

POST /user/validateemail/pw/accept/ (checks email verification code for forgot-pw)

Request

Header

Key	Value	Description
None	None	N/A

Body

{
  "email": "string", // should be automatically set by frontend! not by a user!
  "code": "string"
}

Response

Body

{
  "access": "string"
}

Status Code

Code	key of Message	Description
200	None	N/A (successfully checked)
400	email	missing input value, blank input, invalid email format, length error(✅len<=50)
400	code	missing input value, blank input, length error(✅len==6)
400	fail	wrong code

POST /user/login/ (creates new authorization tokens)

Request

Header

Key	Value	Description
None	None	N/A

Body

{
  "email": "string",
  "password": "string"
}

Response

Body

{
  "access": "string",
  "refresh": "string"
}

Status Code

Code	key of Message	Description
200	None	OK
400	email	missing input value, blank input, invalid email format, no such user w/ the email
400	password	missing input value, blank input, wrong password

POST /user/refresh/ (refreshes user's authorization tokens)

Request

Header

Key	Value	Description
None	None	N/A

Body

{
  "refresh": "string"
}

Response

Body

{
  "access": "string"
}

Status Code

Code	key of Message	Description
200	None	OK
400	refresh	missing input value, blank input
401	detail and code	refresh token expired; user has to attempt a new login

POST /user/logout/ (deletes user's authorization tokens) 🔒

Request

Header

Key	Value	Description
Authorization	Bearer {access}	user's access token (must be sent with the prefix 'Bearer')

Body

{
  "refresh": "string"
}

Response

Status Code

Code	key of Message	Description
200	None	OK
400	refresh	missing input value, blank input
403	detail	no access token was sent in the header
403	detail, code and messages	access token expired; user has to refresh to retrieve a new token

GET /user/profile/ (gets user's profile) 🔒

Request

Header

Key	Value	Description
Authorization	Bearer {access}	user's access token (must be sent with the prefix 'Bearer')

Response

Body

{
  "user": {
    "id": int,
    "email": "string",
    "nickname": "string",
    "updated_at": timestamp
    ... // more fields to be added later
  }
}

Status Code

Code	key of Message	Description
200	None	OK
403	detail	no access token was sent in the header
403	detail, code and messages	access token expired; user has to refresh to retrieve a new token

PATCH /user/profile/nickname/ (changes user's nickname) 🔒

Request

Header

Key	Value	Description
Authorization	Bearer {access}	user's access token (must be sent with the prefix 'Bearer')

Body

{
  "nickname": "string"
}

Response

Status Code

Code	key of Message	Description
200	None	Successfully changed
400	nickname	missing input value, blank input, length error(✅len<=15), same as the original nickname

PATCH /user/profile/password/ (changes user's password) 🔒

Request

Header

Key	Value	Description
Authorization	Bearer {access}	user's access token (must be sent with the prefix 'Bearer')

Body

{
  "password": "string"
}

Response

Status Code

Code	key of Message	Description
200	None	Successfully changed
400	password	missing input value, blank input, length error(✅len>=8)

---

Symbol

POST /symbol/favorite/backup/ (backup user's favorite symbols) 🔒

Request

Header

Key	Value	Description
Authorization	Bearer {access}	user's access token (must be sent with the prefix 'Bearer')

Body

{
  [
    {
      "id": int  // symbol id
    },
    {
      "id": int
    }...
  ]
}

Response

Status Code

Code	key of Message	Description
200	None	OK
400	id	missing input value, blank input, invalid symbol
403	detail	no access token was sent in the header
403	detail, code and messages	access token expired; user has to refresh to retrieve a new token

GET /symbol/favorite/backup/ (get user's favorite symbols) 🔒

Request

Header

Key	Value	Description
Authorization	Bearer {access}	user's access token (must be sent with the prefix 'Bearer')

Response

{
  "results": [
    {
      "id": int  // symbol id
    },
    {
      "id": int
    }...
  ]
}

Status Code

Code	key of Message	Description
200	None	OK
403	detail	no access token was sent in the header
403	detail, code and messages	access token expired; user has to refresh to retrieve a new token

---

Setting

POST /setting/backup/ (backup user's setting) 🔒

Request

Header

Key	Value	Description
Authorization	Bearer {access}	user's access token (must be sent with the prefix 'Bearer')

Body

{
  "display_mode": int,
  "default_menu": int
}

Response

Status Code

Code	key of Message	Description
200	None	OK
400	display_mode	missing input value, blank input, invalid mode
400	default_menu	missing input value, blank input, invalid menu
403	detail	no access token was sent in the header
403	detail, code and messages	access token expired; user has to refresh to retrieve a new token

GET /setting/backup/ (get user's setting) 🔒

Request

Header

Key	Value	Description
Authorization	Bearer {access}	user's access token (must be sent with the prefix 'Bearer')

Response

Body

{
  "display_mode": int,
  "default_menu": int
}

Status Code

Code	key of Message	Description
200	None	OK
403	detail	no access token was sent in the header
403	detail, code and messages	access token expired; user has to refresh to retrieve a new token