최종 API 명세서

메인 뷰

[GET] 전체 프로필 조회

url : http://54.180.159.90:5000/friends

1.Request-Header

`Content-Type` : `application/json`

2. 응답 바디

key	설명	타입	비고
_id	친구 별 아이디 값	String
name	친구 이름	String
part	파트 이름	String
ybob	yb, ob 여부	String
mbti	친구 mbti	String
image	사진 저장 주소	String
place	처음 만난 장소	String
face	닮은꼴	String
banmo	반말 모드 했는지 여부	Boolean
answer1	파트별 질문 답변 1	String
answer2	파트별 질문 답변 2	String
tmi	tmi 질문 답변	String	Null 가능

3. Response-Body 성공

{
    "success": true,
    "list": {
        "_id": "60a9596a2676b5496a7ed216",
        "FreindsList": [
           {
                "_id": "60a9773e5a425d06ededc708",
                "name": "kangmin",
                "part": "Android",
                "ybob": "YB",
                "mbti": "esfj",
                "image": "src",
                "place": "hongdae",
                "face": "pikachu",
                "banmo": true,
                "answer1": "철이 없었죠... 체크셔츠가 많으면 코딩을 잘 할 수 있을거라 생각한게..",
                "answer2": "나는 부엉부엉 부엉이 밤코",
                "tmi": "src"
            },
            {
                "_id": "60a96f599d474f68170ca955",
                "name": "이은솔",
                "part": "기획",
                "ybob": "ob",
                "mbti": "esfp",
                "image": "s3~",
                "place": "홍대",
                "face": "너구리",
                "banmo": true,
                "answer1": "계획하는 일이 세상에서 제일 재밌어",
                "answer2": "앱잼...무셔... 앱잼... 몰라... TI도 조아......",
                "tmi": "열정 넘치는 언니!"
            }
        ]
    }
}

4. 실패

{
    "success": false,
    "message": "전체 프로필 조회 실패"
}

친구 조회 뷰

[GET] 선택한 친구 조회

url : http://54.180.159.90:5000/friends/:id

1.Request-Header

`Content-Type` : `application/json`

2. Request-Params

`id` : `String` , friends Primary Key

3. 응답 바디

key	설명	타입	비고
_id	친구 별 아이디 값	String
name	친구 이름	String
part	파트 이름	String
ybob	yb, ob 여부	String
mbti	친구 mbti	String
image	사진 저장 주소	String
place	처음 만난 장소	String
face	닮은꼴	String
banmo	반말 모드 했는지 여부	Boolean
answer1	파트별 질문 답변 1	String
answer2	파트별 질문 답변 2	String
tmi	tmi 질문 답변	String

4. Response-Body(성공)

{
    "_id": "60a95efd92211d063d7423d2",
    "name": "채정아2",
    "part": "서버",
    "ybob" : "yb",
    "mbti": "entp",
    "image": "s3~",
    "place": "홍대",
    "face": "너구리",
    "banmo": true,
    "answer1": "쌓여있다",
    "answer2": "낮코",
    "tmi" : "~~~"
}

5. 실패

{
    "success": false,
    "message": "친구 프로필 조회 실패"
}  

친구 추가 뷰

[POST] 친구 추가

url : http://54.180.159.90:5000/friends

1.Request-Header

`Content-Type` : `application/json`

2. 요청 바디

key	설명	타입	비고
_id	친구 별 아이디 값	String
name	친구 이름	String
part	파트 이름	String
ybob	yb, ob 여부	String
mbti	친구 mbti	String
image	사진 저장 주소	String
place	처음 만난 장소	String
face	닮은꼴	String
banmo	반말 모드 했는지 여부	Boolean
answer1	파트별 질문 답변 1	String
answer2	파트별 질문 답변 2	String
tmi	tmi 질문 답변	String	Null 가능

3. Request-Body

{
	"name" : "채정아",
	"part" : "서버",
        "ybob" : "ob", 
	"mbti" : "entp",
	"image" : "s3~",
	"place" : "홍대",
	"face" : "너구리",
	"banmo" : true,
	"answer1" : "쌓여있다",
	"answer2" : "낮코",
	"tmi" : "~" or null
}

4. Response-Body (성공)

{
	"status" :200,
	"success": true,
	"messsage" : "프로필 저장 성공"
}

5. 실패

{
    "success": false,
    "message": "프로필 저장 실패했습니다."
}