REST API 예시

im_taeho·2024년 1월 11일
0

마이페이지

  • 내 정보를 반환받는 기능입니다.
  • HTTP 헤더Authorization 필드에 Access Token을 포함하여 전송해야 합니다.
GET /users/me

성공: 200 OK
실패:

CodeMessageDescription
401Access Token 만료사용자의 Access Token이 만료되었거나 유효하지 않은 경우

요청 헤더

NameDescription
AuthorizationBearer + JWT Access Token

요청 파라미터
없음

요청 필드
없음

응답 필드

FieldTypeDescription
nicknameString닉네임
introductionString자기소개
scoreInteger별점
goldInteger금메달 개수
silverInteger은메달 개수
bronzeInteger동메달 개수
useridInteger회원ID (DB 기본키)

요청 예시(URI, 헤더)

GET /users/me
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...

응답 예시(JSON)

{
  "nickname": "닉네임A",
  "introduction": "안녕하세요. 닉네임A 입니다. 반갑습니다.",
  "score": 85,
  "gold": 0,
  "silver": 0,
  "bronze": 3,
  "userid": 8
}

게시판 조회

  • 게시판의 게시글 리스트를 조회하는 기능입니다.
  • HTTP 헤더Authorization 필드에 Access Token을 포함하여 전송해야 합니다.
GET /notices

성공: 200 OK
실패:

CodeMessageDescription
401Access Token 만료사용자의 Access Token이 만료되었거나 유효하지 않은 경우
400유효하지 않은 게시판명게시판명이 "원정대" or "의뢰인"이 아닌 경우
400유효하지 않은 lastidlastid 값이 존재하지 않는 경우
400필수 파라미터 전달 누락필수로 입력해야하는 파라미터를 전달하지 않은 경우

요청 헤더

NameDescription
AuthorizationBearer + JWT Access Token

요청 파라미터

필수ParamsTypeDescription
XlastidInteger마지막으로 호출 된 id (미입력시 최근 id부터 출력)
OamountInteger한번에 호출할 게시글 개수
XtypeString"원정대" or "의뢰인" (미입력시 전체 조회)

요청 필드
없음

응답 필드

FieldTypeDescription
typeString"원정대" or "의뢰인"
titleString제목
scoreInteger별점
genderString성별
categoryString카테고리
createdDateTimeString작성시각
noticeIdInteger게시글ID

요청 예시(URI, 헤더)

GET /notices?lastid=10&amount=2&type=원정대
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...

응답 예시(JSON)

[
  {
    "type": "원정대",
    "title": "게시글111",
    "score": 76,
    "gender": "male",
    "category": "벌레",
    "createdDateTime": "2024-01-12 13:12:50",
    "noticeId": 10
  },
  {
    "type": "원정대",
    "title": "게시글222",
    "score": 93,
    "gender": "female",
    "category": "벌레",
    "createdDateTime": "2024-01-11 20:32:16",
    "noticeId": 9
  }
]

회원가입

  • 신규 회원 정보를 입력받고 회원가입 요청을 보내는 기능입니다.
  • 입력했던 이메일 주소로 회원인증 링크를 전송합니다.
POST /users/signup

성공: 201 Created
실패:

CodeMessageDescription
400아이디 형식 오류아이디 조건에 부합되지 않는 경우
400비밀번호 형식 오류비밀번호 조건에 부합되지 않는 경우
400이메일 형식 오류이메일 조건에 부합되지 않는 경우

요청 헤더
없음

요청 파라미터
없음

요청 필드

FieldTypeDescription
idString아이디
pwString비밀번호
emailString이메일
nicknameString닉네임
genderString성별

응답 필드

FieldTypeDescription
idString아이디
pwString비밀번호
emailString이메일
nicknameString닉네임
genderString성별
userIdInteger회원ID

요청 예시(URI, JSON)

POST /users/signup
{
  "id": "test1",
  "pw": "1q2w3e4r",
  "email": "testmail@naver.com",
  "nickname": "닉네임A",
  "gender": "male"
 }

응답 예시(JSON)

{
  "id": "test1",
  "pw": "1q2w3e4r",
  "email": "testmail@naver.com",
  "nickname": "닉네임A",
  "gender": "male"
  "userId": 1
}
profile
반갑습니다 :)

0개의 댓글