API 명세서 작성 과정 정리

1. “한마디 조회”의 api명세서를 써보자
   

2. Get/Post/Patch/Put/Delete중에 무엇인지 생각

   한마디 조회는 get!

3. url정하기: 앱이름/~~

   url로 넘길 정보 있으면 url에 담아야함 (Query String/Path Variable)
   

4. 이 페이지를 띄우기 위해 필요한것을 생각

   어떤 Post인지id필요!
       (ex 검색이면 검색어가 필요, 밑줄긋기면 어떤 post의 어떤 섹션의 몇번째 문장인지 정보 필요)
   

Request
    Query Params

pk: int           #post id

5. 그러면 내가 반환할것:

   한마디를 반환하니까 모델을 보고 모델의 필드 중 어떤 어떤 정보를 넘길 건지 생각

   
   

   성공시/실패시 나눠서 작성

 성공: 
	한마디 개수
	user 이미지
	user  아이디
	댓글 내용
	내가 좋아요 눌렀는지 아닌지
	답글 있다면 답글까지

Response

200

 {
	"message": "한마디 조회 성공",
	"data": [
 				{
 					"han_id": 1,
 					"user": [
 						{
 							"user_id": 2,
 							"profile" : "http://~[이미지url]",
 							"nickname": "감자뵹뵹"
 						}
 					],
 					"content": "[한마디 내용]",
 					"is_like": true,          # 좋아요 눌렀으면 true 아니면 false
 					"comment": [
 						{
 							"hancom_id": 4,
 							"hancom_user": [
 									{
 										"user_id": 4,
 										"profile" : "http://~[이미지url]",
 										"nickname": "도라에몽"
 									}
 							],
 							"content": "[한마디 댓글 내용]"
 						},
 						{
 							"hancom_id": 6,
 							"hancom_user": [
 									{
 										"user_id": 1,
 										"profile" : "http://~[이미지url]",
 										"nickname": "진구야"
 									}
 							],
 							"content": "[한마디 댓글 내용2]"
 						}
 					]
 				},
 				{
 					"han_id": 2,
 					"user": [
 						{
 							"user_id": 9,
 							"profile" : "http://~[이미지url]",
 							"nickname": "닉넴"
 						}
 					],
 					"content": "[한마디 내용2]",
 					"is_like": false,     
 					"comment": [
 									# 댓글 없으면 없음!
 					]
 				}
 		]
 }

404

존재하지 않는 Post ID를 pk 값에 넣어 요청보낸 경우

 {
     "detail": "찾을 수 없습니다."
 }