Specification - nl-seoultech/tento-server GitHub Wiki

/login/

POST /login/

사용자의 인증된 토큰을 가져옵니다. 인증 토큰을 만들때는 expired_at과 사용자의 id를 이용해서 생성하면됩니다. itsdangerous의 itsdangerous.JSONWebSignature로 만들면될것같습니다.

request

POST /login/ HTTP/1.1
Host: tento.com
Accept: application/json

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "user": {
    "id": 1,
    "email": "[email protected]",
    "name": "admire9"
  },
  "token": "eyJhbGciOiJIUzI1NiJ9.eyJjcmVhdGVkX2F0IjoxMjMxMjMsInVzZXJfaWQiOjF9.0o-Y7oOlvYgN8BH0MxszXoX1iwVf4YNx2sks_s03_KY"
}

/users/

GET /users/`<int:id>`/

<int:id> 번 유저의 정보를 가져옵니다. itsdangerous.JSONWebSignature.loads로 토큰을 가져올때, 조작된 토큰이 넘어올경우 itsdangerous.BadSignature 에러가 나므로 이것을 이용해서 예외 처리를 하면될거같습니다.

query params
- token: 사용자 인증 토큰
request

GET /users/1/?token=eyJhbGciOiJIUzI1NiJ9.eyJjcmVhdGVkX2F0IjoxMjMxMjMsInVzZXJfaWQiOjF9.0o-Y7oOlvYgN8BH0MxszXoX1iwVf4YNx2sks_s03_KY HTTP/1.1
Host: tento.com
Accept: application/json

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 1,
  "email": "[email protected]",
  "name": "admire9"
}

POST /users/

사용자를 추가합니다.

form params
- email: 사용자의 이메일
- password: 사용자의 비밀번호
request

POST /users/ HTTP/1.1
Host: tento.com
Accept: application/json

[email protected]&password=abcdef

또는 

POST /users/ HTTP/1.1
Host: tento.com
Accept: application/json
Content-Type: application/json

{
  "email": "[email protected]",
  "password": "abcdef"
}

response

HTTP/1.1 201 CREATED
Content-Type: application/json

{
  "id": 1,
  "email": "[email protected]",
  "name": "admire9"
}