Skip to content

FE API 구성

Jump to bottom
ink-0 edited this page Jun 28, 2021 · 2 revisions

API 구성

백엔드에게 필요한 API 를 요청하기 위해, 요구사항을 정리하는 문서

자신이 어떤 HTTP 요청으로, 어떤 응답을 받고 싶은지 적어주세요 조회(GET), 추가(POST), 수정(PUT), 삭제(DELETE)

🔗 포스트맨 API 문서 주소

이슈 리스트 조회 💥수정일: 2021-06-22(화), assignees, label 부분 변경됨.💥

📣 GET /api/web/issues?status=''&milestone=''&writer=''&created=``

🖨 쿼리 스트링 (이슈 검색 필터링 조건), 💥 조건은 꼭 기입하지 않아도 됩니다.💥
status: 이슈 상태(open, close, all) ✨ 조건이 없을 경우 기본 값은 all 입니다. ✨
milestone: 마일스톤 아이디, 닉네임? (정해야 함)
writer: 작성자 아이디, 닉네임?
created: 이슈 작성일

Json 예시 
{
    "issues": [
        {
            "issue_id": 2,
            "milestone_info": {
                "title": "마일스톤 제목1",
                "description": "마일스톤 내용1",
                "due_date": "2021-06-22T20:18:38.237"
            },
            "title": "열린 이슈 타이틀1",
            "content": "열린 이슈 설명1",
            "status": "OPEN",
            "writer": {
                "id": null,
                "name": null,
                "profile_image_url": null,
                "emails": null
            },
            "created_date_time": "2021-06-22T20:18:38.237",
            "assignees": [
                {
                    "id": "noel",
                    "name": "노을",
                    "profile_image_url": "http://testProfile.image.url",
                    "emails": [
                        "[email protected]",
                        "[email protected]"
                    ]
                },
                {
                    "id": "pyro",
                    "name": "파이로",
                    "profile_image_url": "http://testProfile.image.url",
                    "emails": [
                        "[email protected]",
                        "[email protected]"
                    ]
                }
            ],
            "labels": [
                {
                    "id": 1,
                    "title": "라벨 타이틀4",
                    "description": "라벨 설명1",
                    "background_color_hexa": "#FF0000",
                    "text_color_hexa": "#000000"
                },
                {
                    "id": 2,
                    "title": "라벨 타이틀5",
                    "description": "라벨 설명2",
                    "background_color_hexa": "#FF0000",
                    "text_color_hexa": "#000000"
                },
                {
                    "id": 3,
                    "title": "라벨 타이틀6",
                    "description": "라벨 설명3",
                    "background_color_hexa": "#FF0000",
                    "text_color_hexa": "#000000"
                }
            ]
        },
        {
            "issue_id": 3,
            "milestone_info": {
                "title": "마일스톤 제목2",
                "description": "마일스톤 내용2",
                "due_date": "2021-06-22T20:18:38.237"
            },
            "title": "열린 이슈 타이틀2",
            "content": "열린 이슈 설명2",
            "status": "OPEN",
            "writer": {
                "id": null,
                "name": null,
                "profile_image_url": null,
                "emails": null
            },
            "created_date_time": "2021-06-22T20:18:38.237",
            "assignees": [
                {
                    "id": "noel",
                    "name": "노을",
                    "profile_image_url": "http://testProfile.image.url",
                    "emails": [
                        "[email protected]",
                        "[email protected]"
                    ]
                },
                {
                    "id": "pyro",
                    "name": "파이로",
                    "profile_image_url": "http://testProfile.image.url",
                    "emails": [
                        "[email protected]",
                        "[email protected]"
                    ]
                }
            ],
            "labels": [
                {
                    "id": 1,
                    "title": "라벨 타이틀4",
                    "description": "라벨 설명1",
                    "background_color_hexa": "#FF0000",
                    "text_color_hexa": "#000000"
                },
                {
                    "id": 2,
                    "title": "라벨 타이틀5",
                    "description": "라벨 설명2",
                    "background_color_hexa": "#FF0000",
                    "text_color_hexa": "#000000"
                },
                {
                    "id": 3,
                    "title": "라벨 타이틀6",
                    "description": "라벨 설명3",
                    "background_color_hexa": "#FF0000",
                    "text_color_hexa": "#000000"
                }
            ]
        }
    ]
}

특정 이슈 조회

GET api/web/issues/{issueId}

json 예시 
{
    "issue_id": 1,
    "milestone_info": {
        "title": "마일스톤 제목1",
        "description": "마일스톤 내용1",
        "due_date": "2021-06-18T01:47:06.705"
    },
    "title": "검색한 이슈 타이틀1",
    "content": "닫힌 이슈 설명1",
    "status": false,
    "writer": {
        "email": "[email protected]",
        "name": "테스터",
        "avatar_url": "http://testProfile.image.url"
    },
    "created_date_time": "2021-06-18T01:47:06.705",
    "assignees": {
        "users": [
            {
                "email": "[email protected]",
                "name": "담당자",
                "avatar_url": "http://testProfile.image.url"
            },
            {
                "email": "[email protected]",
                "name": "담당자2",
                "avatar_url": "http://testProfile.image.url"
            }
        ]
    },
    "labels": {
        "labels": [
            {
                "id": 1,
                "title": "라벨 타이틀1",
                "description": "라벨 설명1",
                "background_color_hexa": "#FF0000",
                "text_color_hexa": "#000000"
            },
            {
                "id": 2,
                "title": "라벨 타이틀2",
                "description": "라벨 설명2",
                "background_color_hexa": "#FF0000",
                "text_color_hexa": "#000000"
            },
            {
                "id": 3,
                "title": "라벨 타이틀3",
                "description": "라벨 설명3",
                "background_color_hexa": "#FF0000",
                "text_color_hexa": "#000000"
            }
        ]
    },
    "comments": {
        "comments": [
            {
                "id": 1,
                "write": {
                    "email": "[email protected]",
                    "name": "테스터",
                    "avatar_url": "http://testProfile.image.url"
                },
                "content": "댓글내용1",
                "date_time": "2021-06-18T01:47:06.717"
            },
            {
                "id": 2,
                "write": {
                    "email": "[email protected]",
                    "name": "테스터2",
                    "avatar_url": "http://testProfile.image.url"
                },
                "content": "댓글내용3",
                "date_time": "2021-06-18T01:47:06.717"
            },
            {
                "id": 3,
                "write": {
                    "email": "[email protected]",
                    "name": "테스터2",
                    "avatar_url": "http://testProfile.image.url"
                },
                "content": "댓글내용4",
                "date_time": "2021-06-18T01:47:06.717"
            }
        ]
    }
}

이슈 생성 버튼 클릭 시 요청하는 API 💥추가일: 2021-06-22(화)💥

담당자, 레이블, 마일스톤 리스트 정보를 제공해줌

📣 GET /api/web/issues/form

json 예시 
{
    "labels": [
        {
            "id": 1,
            "title": "라벨 타이틀4",
            "description": "라벨 설명1",
            "background_color_hexa": "#FF0000",
            "text_color_hexa": "#000000"
        },
        {
            "id": 2,
            "title": "라벨 타이틀5",
            "description": "라벨 설명2",
            "background_color_hexa": "#FF0000",
            "text_color_hexa": "#000000"
        },
        {
            "id": 3,
            "title": "라벨 타이틀6",
            "description": "라벨 설명3",
            "background_color_hexa": "#FF0000",
            "text_color_hexa": "#000000"
        }
    ],
    "assignees": [
        {
            "id": "noel",
            "name": "노을",
            "profile_image_url": "http://testProfile.image.url",
            "emails": [
                "[email protected]",
                "[email protected]"
            ]
        },
        {
            "id": "pyro",
            "name": "파이로",
            "profile_image_url": "http://testProfile.image.url",
            "emails": [
                "[email protected]",
                "[email protected]"
            ]
        }
    ],
    "milestones": [
        {
            "id": 1,
            "title": "마일스톤 제목1",
            "description": "마일스톤 내용1",
            "due_date": "2021-06-22T20:14:44.65"
        }
    ]
}

마일스톤 조회

GET api/web/milestones

json 예시 
{
    "milestones": [
        {
            "id": 1,
            "issues": {
                "issues": [
                    {
                        "issue_id": 2,
                        "milestone_info": {
                            "title": "마일스톤 제목1",
                            "description": "마일스톤 내용1",
                            "due_date": "2021-06-18T01:42:07.905"
                        },
                        "title": "열린 이슈 타이틀1",
                        "content": "열린 이슈 설명1",
                        "status": true,
                        "writer": {
                            "email": "[email protected]",
                            "name": "네오",
                            "avatar_url": "http://testProfile.image.url"
                        },
                        "created_date_time": "2021-06-18T01:42:07.905",
                        "assignees": {
                            "users": [
                                {
                                    "email": "[email protected]",
                                    "name": "노을",
                                    "avatar_url": "http://testProfile.image.url"
                                },
                                {
                                    "email": "[email protected]",
                                    "name": "파이로",
                                    "avatar_url": "http://testProfile.image.url"
                                }
                            ]
                        },
                        "labels": {
                            "labels": [
                                {
                                    "id": 1,
                                    "title": "라벨 타이틀4",
                                    "description": "라벨 설명1",
                                    "background_color_hexa": "#FF0000",
                                    "text_color_hexa": "#000000"
                                },
                                {
                                    "id": 2,
                                    "title": "라벨 타이틀5",
                                    "description": "라벨 설명2",
                                    "background_color_hexa": "#FF0000",
                                    "text_color_hexa": "#000000"
                                },
                                {
                                    "id": 3,
                                    "title": "라벨 타이틀6",
                                    "description": "라벨 설명3",
                                    "background_color_hexa": "#FF0000",
                                    "text_color_hexa": "#000000"
                                }
                            ]
                        }
                    },
                    {
                        "issue_id": 5,
                        "milestone_info": {
                            "title": "마일스톤 제목1",
                            "description": "마일스톤 내용1",
                            "due_date": "2021-06-18T01:42:07.905"
                        },
                        "title": "열린 이슈 타이틀2",
                        "content": "열린 이슈 설명1",
                        "status": true,
                        "writer": {
                            "email": "[email protected]",
                            "name": "네오",
                            "avatar_url": "http://testProfile.image.url"
                        },
                        "created_date_time": "2021-06-18T01:42:07.905",
                        "assignees": {
                            "users": [
                                {
                                    "email": "[email protected]",
                                    "name": "노을",
                                    "avatar_url": "http://testProfile.image.url"
                                },
                                {
                                    "email": "[email protected]",
                                    "name": "파이로",
                                    "avatar_url": "http://testProfile.image.url"
                                }
                            ]
                        },
                        "labels": {
                            "labels": [
                                {
                                    "id": 1,
                                    "title": "라벨 타이틀4",
                                    "description": "라벨 설명1",
                                    "background_color_hexa": "#FF0000",
                                    "text_color_hexa": "#000000"
                                },
                                {
                                    "id": 2,
                                    "title": "라벨 타이틀5",
                                    "description": "라벨 설명2",
                                    "background_color_hexa": "#FF0000",
                                    "text_color_hexa": "#000000"
                                },
                                {
                                    "id": 3,
                                    "title": "라벨 타이틀6",
                                    "description": "라벨 설명3",
                                    "background_color_hexa": "#FF0000",
                                    "text_color_hexa": "#000000"
                                }
                            ]
                        }
                    },
                    {
                        "issue_id": 6,
                        "milestone_info": {
                            "title": "마일스톤 제목1",
                            "description": "마일스톤 내용1",
                            "due_date": "2021-06-18T01:42:07.905"
                        },
                        "title": "열린 이슈 타이틀3",
                        "content": "열린 이슈 설명1",
                        "status": true,
                        "writer": {
                            "email": "[email protected]",
                            "name": "네오",
                            "avatar_url": "http://testProfile.image.url"
                        },
                        "created_date_time": "2021-06-18T01:42:07.905",
                        "assignees": {
                            "users": [
                                {
                                    "email": "[email protected]",
                                    "name": "노을",
                                    "avatar_url": "http://testProfile.image.url"
                                },
                                {
                                    "email": "[email protected]",
                                    "name": "파이로",
                                    "avatar_url": "http://testProfile.image.url"
                                }
                            ]
                        },
                        "labels": {
                            "labels": [
                                {
                                    "id": 1,
                                    "title": "라벨 타이틀4",
                                    "description": "라벨 설명1",
                                    "background_color_hexa": "#FF0000",
                                    "text_color_hexa": "#000000"
                                },
                                {
                                    "id": 2,
                                    "title": "라벨 타이틀5",
                                    "description": "라벨 설명2",
                                    "background_color_hexa": "#FF0000",
                                    "text_color_hexa": "#000000"
                                },
                                {
                                    "id": 3,
                                    "title": "라벨 타이틀6",
                                    "description": "라벨 설명3",
                                    "background_color_hexa": "#FF0000",
                                    "text_color_hexa": "#000000"
                                }
                            ]
                        }
                    },
                    {
                        "issue_id": 7,
                        "milestone_info": {
                            "title": "마일스톤 제목2",
                            "description": "마일스톤 내용2",
                            "due_date": "2021-06-18T01:42:07.905"
                        },
                        "title": "열린 이슈 타이틀4",
                        "content": "열린 이슈 설명2",
                        "status": true,
                        "writer": {
                            "email": "[email protected]",
                            "name": "네오",
                            "avatar_url": "http://testProfile.image.url"
                        },
                        "created_date_time": "2021-06-18T01:42:07.905",
                        "assignees": {
                            "users": [
                                {
                                    "email": "[email protected]",
                                    "name": "노을",
                                    "avatar_url": "http://testProfile.image.url"
                                },
                                {
                                    "email": "[email protected]",
                                    "name": "파이로",
                                    "avatar_url": "http://testProfile.image.url"
                                }
                            ]
                        },
                        "labels": {
                            "labels": [
                                {
                                    "id": 1,
                                    "title": "라벨 타이틀4",
                                    "description": "라벨 설명1",
                                    "background_color_hexa": "#FF0000",
                                    "text_color_hexa": "#000000"
                                },
                                {
                                    "id": 2,
                                    "title": "라벨 타이틀5",
                                    "description": "라벨 설명2",
                                    "background_color_hexa": "#FF0000",
                                    "text_color_hexa": "#000000"
                                },
                                {
                                    "id": 3,
                                    "title": "라벨 타이틀6",
                                    "description": "라벨 설명3",
                                    "background_color_hexa": "#FF0000",
                                    "text_color_hexa": "#000000"
                                }
                            ]
                        }
                    }
                ]
            },
            "milestone_info": {
                "title": "마일스톤 제목1",
                "description": "마일스톤 내용1",
                "due_date": "2021-06-18T01:42:07.905"
            }
        },
        {
            "id": 2,
            "issues": {
                "issues": [
                    {
                        "issue_id": 2,
                        "milestone_info": {
                            "title": "마일스톤 제목1",
                            "description": "마일스톤 내용1",
                            "due_date": "2021-06-18T01:42:07.905"
                        },
                        "title": "열린 이슈 타이틀1",
                        "content": "열린 이슈 설명1",
                        "status": true,
                        "writer": {
                            "email": "[email protected]",
                            "name": "네오",
                            "avatar_url": "http://testProfile.image.url"
                        },
                        "created_date_time": "2021-06-18T01:42:07.905",
                        "assignees": {
                            "users": [
                                {
                                    "email": "[email protected]",
                                    "name": "노을",
                                    "avatar_url": "http://testProfile.image.url"
                                },
                                {
                                    "email": "[email protected]",
                                    "name": "파이로",
                                    "avatar_url": "http://testProfile.image.url"
                                }
                            ]
                        },
                        "labels": {
                            "labels": [
                                {
                                    "id": 1,
                                    "title": "라벨 타이틀4",
                                    "description": "라벨 설명1",
                                    "background_color_hexa": "#FF0000",
                                    "text_color_hexa": "#000000"
                                },
                                {
                                    "id": 2,
                                    "title": "라벨 타이틀5",
                                    "description": "라벨 설명2",
                                    "background_color_hexa": "#FF0000",
                                    "text_color_hexa": "#000000"
                                },
                                {
                                    "id": 3,
                                    "title": "라벨 타이틀6",
                                    "description": "라벨 설명3",
                                    "background_color_hexa": "#FF0000",
                                    "text_color_hexa": "#000000"
                                }
                            ]
                        }
                    },
                    {
                        "issue_id": 5,
                        "milestone_info": {
                            "title": "마일스톤 제목1",
                            "description": "마일스톤 내용1",
                            "due_date": "2021-06-18T01:42:07.905"
                        },
                        "title": "열린 이슈 타이틀2",
                        "content": "열린 이슈 설명1",
                        "status": true,
                        "writer": {
                            "email": "[email protected]",
                            "name": "네오",
                            "avatar_url": "http://testProfile.image.url"
                        },
                        "created_date_time": "2021-06-18T01:42:07.905",
                        "assignees": {
                            "users": [
                                {
                                    "email": "[email protected]",
                                    "name": "노을",
                                    "avatar_url": "http://testProfile.image.url"
                                },
                                {
                                    "email": "[email protected]",
                                    "name": "파이로",
                                    "avatar_url": "http://testProfile.image.url"
                                }
                            ]
                        },
                        "labels": {
                            "labels": [
                                {
                                    "id": 1,
                                    "title": "라벨 타이틀4",
                                    "description": "라벨 설명1",
                                    "background_color_hexa": "#FF0000",
                                    "text_color_hexa": "#000000"
                                },
                                {
                                    "id": 2,
                                    "title": "라벨 타이틀5",
                                    "description": "라벨 설명2",
                                    "background_color_hexa": "#FF0000",
                                    "text_color_hexa": "#000000"
                                },
                                {
                                    "id": 3,
                                    "title": "라벨 타이틀6",
                                    "description": "라벨 설명3",
                                    "background_color_hexa": "#FF0000",
                                    "text_color_hexa": "#000000"
                                }
                            ]
                        }
                    },
                    {
                        "issue_id": 6,
                        "milestone_info": {
                            "title": "마일스톤 제목1",
                            "description": "마일스톤 내용1",
                            "due_date": "2021-06-18T01:42:07.905"
                        },
                        "title": "열린 이슈 타이틀3",
                        "content": "열린 이슈 설명1",
                        "status": true,
                        "writer": {
                            "email": "[email protected]",
                            "name": "네오",
                            "avatar_url": "http://testProfile.image.url"
                        },
                        "created_date_time": "2021-06-18T01:42:07.905",
                        "assignees": {
                            "users": [
                                {
                                    "email": "[email protected]",
                                    "name": "노을",
                                    "avatar_url": "http://testProfile.image.url"
                                },
                                {
                                    "email": "[email protected]",
                                    "name": "파이로",
                                    "avatar_url": "http://testProfile.image.url"
                                }
                            ]
                        },
                        "labels": {
                            "labels": [
                                {
                                    "id": 1,
                                    "title": "라벨 타이틀4",
                                    "description": "라벨 설명1",
                                    "background_color_hexa": "#FF0000",
                                    "text_color_hexa": "#000000"
                                },
                                {
                                    "id": 2,
                                    "title": "라벨 타이틀5",
                                    "description": "라벨 설명2",
                                    "background_color_hexa": "#FF0000",
                                    "text_color_hexa": "#000000"
                                },
                                {
                                    "id": 3,
                                    "title": "라벨 타이틀6",
                                    "description": "라벨 설명3",
                                    "background_color_hexa": "#FF0000",
                                    "text_color_hexa": "#000000"
                                }
                            ]
                        }
                    },
                    {
                        "issue_id": 7,
                        "milestone_info": {
                            "title": "마일스톤 제목2",
                            "description": "마일스톤 내용2",
                            "due_date": "2021-06-18T01:42:07.905"
                        },
                        "title": "열린 이슈 타이틀4",
                        "content": "열린 이슈 설명2",
                        "status": true,
                        "writer": {
                            "email": "[email protected]",
                            "name": "네오",
                            "avatar_url": "http://testProfile.image.url"
                        },
                        "created_date_time": "2021-06-18T01:42:07.905",
                        "assignees": {
                            "users": [
                                {
                                    "email": "[email protected]",
                                    "name": "노을",
                                    "avatar_url": "http://testProfile.image.url"
                                },
                                {
                                    "email": "[email protected]",
                                    "name": "파이로",
                                    "avatar_url": "http://testProfile.image.url"
                                }
                            ]
                        },
                        "labels": {
                            "labels": [
                                {
                                    "id": 1,
                                    "title": "라벨 타이틀4",
                                    "description": "라벨 설명1",
                                    "background_color_hexa": "#FF0000",
                                    "text_color_hexa": "#000000"
                                },
                                {
                                    "id": 2,
                                    "title": "라벨 타이틀5",
                                    "description": "라벨 설명2",
                                    "background_color_hexa": "#FF0000",
                                    "text_color_hexa": "#000000"
                                },
                                {
                                    "id": 3,
                                    "title": "라벨 타이틀6",
                                    "description": "라벨 설명3",
                                    "background_color_hexa": "#FF0000",
                                    "text_color_hexa": "#000000"
                                }
                            ]
                        }
                    }
                ]
            },
            "milestone_info": {
                "title": "마일스톤 제목2",
                "description": "마일스톤 내용2",
                "due_date": "2021-06-18T01:42:07.905"
            }
        }
    ]
}

이슈 댓글 조회

GET api/web/issues/{issueId}/comments

json 예시 
{
    "comments": [
        {
            "id": 1,
            "write": {
                "email": "[email protected]",
                "name": "테스터",
                "avatar_url": "http://testProfile.image.url"
            },
            "content": "댓글내용1",
            "date_time": "2021-06-17T22:08:28.213"
        },
        {
            "id": 2,
            "write": {
                "email": "[email protected]",
                "name": "테스터2",
                "avatar_url": "http://testProfile.image.url"
            },
            "content": "댓글내용3",
            "date_time": "2021-06-17T22:08:28.214"
        },
        {
            "id": 3,
            "write": {
                "email": "[email protected]",
                "name": "테스터2",
                "avatar_url": "http://testProfile.image.url"
            },
            "content": "댓글내용4",
            "date_time": "2021-06-17T22:08:28.214"
        }
    ]
}

라쿤이 작성해주신 양식

로그인 API

GitHub Authorization Code 를 클라이언트 서버에 전달해서, jwt 를 받아오는 API 를 원합니다!

POST /api/auth?code=""

Request Body

{ code: "string" }

Response

{ token: "jwt_token" }

IssueList 조회

IssueList page에 보여 줄 리스트

GET /api/issue?issueList=''

Request Header

Autorization: "Bearer ${jwt}"

Response

{ issueList: [{id: 1, title: 'title', content: 'content', ... }, {id: 2, title: 'title', content: 'content', ... }, ...] }

Issue 작성

사용자가 이슈를 작성하고, 완료 버튼을 눌렀을 때

POST /api/issue?issueAdd=''

Request Body

{ title: "title", content: "content", attachFile: '' }
Clone this wiki locally