Skip to content

API 명세

Zin0_0 edited this page Nov 11, 2020 · 7 revisions

Documentation

URL list

User

  • GET /users
    • 추가할 수 있는 assignee 목록 조회
  • POST /users
    • 회원가입
    • nickname, password
  • GET /users/me
    • 현재 유저정보
  • POST /users/login
    • 일반 로그인
    • nickname, password
  • GET /users/login/github
    • github login url 조회
  • POST /users/login/github
    • 토큰 발급
    • code

Issue

  • GET /issues
    • 전체 issue 목록 조회
    • (label, milestone 개수 포함)
    • 필터링 조건은 querystring 으로
  • POST /issues
    • issue 생성
    • title, label 배열, assignee 배열, milestone 배열
    • is_issue가 true인 comment의 content
  • PATCH /issues
    • 여러 issue 를 open or close 상태 동시 수정
    • issue id 배열 및 변경하려는 상태
  • GET /issues/:issueId
    • id로 단일 issue 조회
    • (해당 issue의 comment 목록 포함)
    • (해당 issue의 assignee, label, milestone 목록 포함)
  • PATCH /issues/:issueId
    • issue title 수정 → title
    • issue open or close 상태 수정 → is_open
  • POST /issues/:issueId/comments
    • issue의 댓글 생성
    • content
  • PUT /issues/:issueId/labels
    • issue에 관련된 label 목록 수정
    • label 배열
  • PUT /issues/:issueId/assignees
    • issue에 관련된 assignee 목록 수정
    • assignee 배열
  • PUT /issues/:issueId/milestones
    • issue에 관련된 milestone 목록 수정
    • milestone 배열

Comment

  • PATCH /comments/:commentId
    • comment 내용 수정
    • content
  • POST /comments/:commentId/reactions
    • comment에 reaction 추가
    • id
  • DELETE /comments/:commentId/reactions/:reactionId

Label

  • GET /labels
    • label 목록 조회
  • POST /labels
    • label 생성
  • PUT /labels/:labelId
    • label 수정
    • title, content, color
  • DELETE /labels/:labelId
    • label 삭제

Milestone

  • GET /milestones
    • milestone 목록 조회
  • POST /milestones
    • milestone 생성
  • PUT /milestones/:milestoneId
    • milestone 수정
    • title, due_date, content
  • DELETE /milestones/:milestoneId
    • milestone 삭제

Image

  • POST /images
    • 이미지 업로드
    • url, title
  • GET /images/:uuid

📁 Documents


⚖ Rules


🖊 Records

☕️ 일일 회고 & 데일리 스크럼
🗓 주간 회고
👨‍👦‍👦 피어 세션

🤯 Tech

Clone this wiki locally