Skip to content

API Documentation

이한주 edited this page Nov 6, 2020 · 14 revisions

Postman을 이용한 api 확인

  • 특이사항 : 로그인, 회원가입을 제외하고 요청시 header에 key: Authorization , value : bearer 'token' 넣어야됨
  • Postman 열기

User

메소드 경로 짧은 설명 링크
POST api/user/signup 회원가입 링크
POST api/user/login 로그인 링크
GET api/user/oauth/github 깃헙 로그인 및 회원가입 링크
POST api/user/oauth/apple 애플 로그인 및 회원가입 링크
GET api/user/status 사용자 검증 링크

Issue

Issue CRU

메소드 경로 짧은 설명
GET api/issue Issue 불러오기
POST api/issue Issue 생성
PUT api/issue/:issueid Issue 수정

Comment CRUD

메소드 경로 짧은 설명
GET api/issue/:issueid/comment Comment 불러오기
POST api/issue/:issueid/comment Comment 추가
PUT api/issue/:issueid/comment/:commentid Comment 수정
DELETE api/issue/:issueid/comment/:commentid Comment 삭제

Assignee CRD

메소드 경로 짧은 설명
GET api/issue/:issueid/assignee Assignee 불러오기
POST api/issue/:issueid/assignee Assignee 추가
DELETE api/issue/:issueid/assignee/:assineeid Assignee 삭제

Label CRD

메소드 경로 짧은 설명
GET api/issue/:issueid/label Label 불러오기
POST api/issue/:issueid/label Label 추가
DELETE api/issue/:issueid/label/:labelid Label 삭제

Milestone CD

메소드 경로 짧은 설명
PUT api/issue/:issueid/milestone/:milestoneid Milestone 할당
DELETE api/issue/:issueid/milestone/ Milestone 삭제

Label

메소드 경로 짧은 설명 링크
GET api/label label 불러오기 링크
POST api/label label 생성 링크
PUT api/label/:labelid label 수정 링크
DELETE api/label/:labelid label 삭제 링크

Milestone

메소드 경로 짧은 설명
GET api/milestone milestone 불러오기
POST api/milestone milestone 생성
PUT api/milestone/:milestone milestone 수정
DELETE api/milestone/:milestone milestone 삭제