스펙 문서 양식

문서 제목

• Method : GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH
• URL : /엔티티/아이디/엔티티/아이디
• Content-Type : application/json; charset=utf-8

Request

필드명	타입	필수여부	설명
필드명	String	Required / None	...

예제

http 메소드 https://:your-site/users/:id

Response

• 데이터를 포함한 응답인 경우

필드명	타입	필수여부	설명
필드명	String	Required / None	...

http status code	code	message	comment
200 / 201 / 204	0	SUCCESS	정상 응답
400	0	FAIL	비정상 응답
401	0	Unathorized	로그인 필요
403	0	Forbidden	권한 없음

• POST 성공: 201
• DELETE 성공: 204
• 나머지 성공: 200

예제

{
    "profile_image" : "aaaa",
    "n_th" : "12",
    "name" : "bbbb",
    "id": "cccc",
    "department" : "컴소과",
    "documents" : "1",
    "comments" : "2",
    "like" : "3"
}