API Documentation - boostcamp-2020/IssueTracker-14 GitHub Wiki
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 ์ญ์ |