REST API 규격서 공통

Server: www.javabrain.kr

Port: 8080

Request: application/json

Response: json

 

할일 목록 가져오기

-protocol: /api/todo

-Method: get

-Query Parameter: start_index=0, page_size=5 (옵션)

-Response

[

{

“todo_id”: 194,

“isFinished”: true,

“todo”: “수정완료3”,

“created”: “2017-09-02 10:23:27.0”,

“updated”: “2017-09-02 11:32:26.0”

},

{

“todo_id”: 190,

“isFinished”: false,

“todo”: “111”,

“created”: “2017-09-01 21:23:32.0”,

“updated”: “2017-10-18 16:33:27.0”

}

]

 

할일 추가하기

-protocol: /api/todo

-Method: post

-Request

{

“todo”: “빨래하기”

}

– Response

{

“todo_id”: 195,

“isFinished”: false,

“todo”: “빨래하기”,

“created”: “2017-10-21 12:08:35.0”,

“updated”: “2017-10-21 12:08:35.0”

}

할일 수정하기

-protocol: /api/todo

-Method: put

-Request

{

“todo_id”: 195,

“isFinished”: true,

“todo”: “빨래 끝”

}

– Response

{

“todo_id”: 195,

“isFinished”: true,

“todo”: “빨래 끝”,

“created”: “2017-10-21 12:08:35.0”,

“updated”: “2017-10-21 12:10:07.0”

}

 

할일 삭제하기

-protocol: /api/todo?todo_id=1

-Method: delete

-Response

{

“result”: 0,

“value”: “success”

}

 

Comments are closed.