highjinro_backend

KOREA UNIVERSITY hackaton

API request url hacka.iwin247.kr

API Document

• Common Response HTTP 200: Success

  HTTP 400: Params Missing

  HTTP 401: Bad Request

  HTTP 404: not found

  HTTP 500: DB error

• POST /auth/signup : User register

Params

id : User's ID [String]

passwd : User's   Password [String]

name : User name

interest_field : User school interest

interest_school : User interest_school

file : image file

gender : user gender

Response

HTTP 200 : send User

HTTP 400 : Param missing

• POST /auth/signin : User login

Params

id : User's ID [String]

passwd : User's  Password [String]

Response

HTTP 200 : send User

HTTP 400 : Param missing

HTTP 412 : incorrect id or password

HTTP 500 : DB err

• GET /auth/fb/token : facebook auth

Params

access_token : user facebook access_token [String]

Response

HTTP 200 : send User

HTTP 400 : Param missing

HTTP 412 : incorrect id or password

HTTP 500 : DB err

• GET /auth/auto/{token} : Auto Login

Params

token : token [String]

Response

HTTP 200 : UserID and token

HTTP 404 : User not found

HTTP 500 : DB err

• GET /user/{token} : Auto Login

Params

token : token [String]

Response

HTTP 200 : send user

HTTP 404 : User not found

HTTP 500 : DB err

• GET /user/{token}/fb/token : facebook Peristalsis to user

Params

token : user token [String]

access_token : user facebook token [String]

Response

HTTP 200 : send user

HTTP 404 : User not found

HTTP 500 : DB err

• GET /schools : school

Response

HTTP 200 : send all school

HTTP 404 : school not found

• GET /schools/:name : school find

Params

name : find school name [String]

Response

HTTP 200 : send school

HTTP 404 : school not found

• GET /schools/tag : tag

Response

HTTP 200 : send tag

HTTP 404 : school not found

• GET /schools/tag/{interest} : tag

Params

interest : 디자인,항공,남 이런식으로

Response

   HTTP 200 : send schools

HTTP 404 : school not found

• GET /boards

Response

HTTP 200 : return board json

• POST /boards/write

Params

       file: if user upload image use key file

    token: writer token  [String]

    date: date  [String]

    title: title name [String]

    contents: contents [String]

Response

    HTTP 200 : return Success

    HTTP 500 : send reason "already exists" or DB ERROR (it change 409 to 500)

• POST /boards/comment

Params

token: writer token [String]

boardid: boardid [String]

summary: comment summary [String]

Response

HTTP 200 : return Success

HTTP 401 : not vaild token

HTTP 500 : send reason "already exists" or DB ERROR

• GET /boards/{boardid}

Response

HTTP 200 : return board detail

HTTP 400 : not vaild id

• PUT /boards/like

Params

boardid: boardid [String]

Response

HTTP 200 : return board 

HTTP 400 : not vaild id

• PUT /boards/dislike

Params

boardid: boardid [String]

Response

HTTP 200 : return board 

HTTP 400 : not vaild id

• DELETE /boards/destroy

Params

boardid: boardid [String]

Response

HTTP 200 : goodbye

HTTP 400 : not vaild id

HTTP 401 : param not found

HTPP 500 : DB ERR

• PUT /boards/edit (chane post to put)

Params

boardid: boardid [String]

title: title [String]

contents: contents [String}

Response

HTTP 200 : changed

HTTP 401 : not vaild board id

HTTP 500 : DB ERR

• GET /board

Response

HTTP 200 : return board json

• POST /board/write

Params

    file: if user upload image use key file

    token: writer token  [String]

    date: date  [String]

    title: title name [String]

    contents: contents [String]

Response

    HTTP 200 : return Success

    HTTP 500 : send reason "already exists" or DB ERROR (it change 409 to 500)

• POST /board/comment

Params

token: writer token [String]

boardid: boardid [String]

comment: board comment [String]

date: write date [String]

Response

HTTP 200 : return Success

HTTP 401 : not vaild token

HTTP 500 : send reason "already exists" or DB ERROR

• GET /board/{boardid}

Response

HTTP 200 : return board detail

HTTP 400 : not vaild id

• PUT /board/like

Params

boardid: boardid [String]

Response

HTTP 200 : return board 

HTTP 400 : not vaild id

• PUT /board/dislike

Params

boardid: boardid [String]

Response

HTTP 200 : return board 

HTTP 400 : not vaild id

• DELETE /board/destroy

Params

boardid: boardid [String]

Response

HTTP 200 : goodbye

HTTP 400 : not vaild id

HTTP 401 : param not found

HTPP 500 : DB ERR

• PUT /board/edit (chane post to put)

Params

boardid: boardid [String]

title: title [String]

contents: contents [String}

Response

HTTP 200 : changed

HTTP 401 : not vaild board id

HTTP 500 : DB ERR

Database Schema

User

id : User's id [String required unique]

facebook_id : user facebook id [String]

pw : User's Password [String required]

token : User token [String]

interest_field : User interest field

interest_school : user interest school

School

code : school_code [String]

name : school_name [String]

tag : 국공사립 [String]

pathways: 진학률 [Number]

employment: 취업률 [Number]

class : 학교분류 [String]

location_x

location_y

coeducation 공학여부

schooltags

tag : 학교태그 [String]

schools : schools [String array]