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 ์‚ญ์ œ