Skip to content

API 명세서

윤주리 edited this page Jul 6, 2022 · 4 revisions

✔️ 로그인 인증 URL 조회하기

POST /api/auth/token

Request

{ 
    "url" : "github redirect url"
}

Response

  • 성공 : 200 OK

✔️ 로그인

POST /api/auth/token

Request

{
    "code" : "code"
}

Response

  • 성공 : 200 OK
{
    "accesstoken" : "aaaaaaaaaa.bbbbbbbbbb.cccccccccc"
}
  • 실패 : 401 Unauthorized

✔️ 게시물 등록하기

POST /api/articles

Request

{ 
    "title" : "제 컴퓨터가 이상해요"
    "content" : "컴퓨터가 안켜져요 : 윈도우라서 그래요...? ㅗㅗ"
    "category" : "question"
}

Response

  • 성공 : 201 Created
{
    "id" : 1
}
  • 실패
    • 400 : Bad Request

      • 데이터 형식이 올바르지 않을 경우
      • 제목: 제목은 1글자 이상 500자 이하여야 합니다
      • 내용: 내용은 10000자 이하여야 합니다
      • 카테고리: question, discussion 이외의 것이 요청 올 경우
    • 401 : Unauthorized

      • 글 등록 요청 시점에 accessToken 유효시간이 만료되었을 경우
        • 로그인 유효시간이 만료되었습니다. 다시 로그인 해주세요.
      • acessToken의 값이 비어 있거나 유효하지 않을 때
        • 유효하지 않은 토큰입니다.
    • 404 : Not Found

      • 사용자가 존재하지 않을 경우
        • 존재 하지 않은 사용자입니다.
Clone this wiki locally