api_spec

• 개요
• 회원 API
  • 회원가입
  • 로그인
  • 로그아웃
• 카테고리 API
  • 카테고리 조회
  • 카테고리 생성
  • 카테고리 수정
  • 카테고리 삭제
• 커뮤니티 피드 게시판 API
  • 커뮤니티 게시판 조회
  • 커뮤니티 회원별 게시판 조회
  • 커뮤니티 특정 게시물 조회
  • 커뮤니티 게시물 작성
  • 커뮤니티 게시물 수정
  • 커뮤니티 게시물 삭제

개요

• api 스펙

회원 API

회원가입

• api: /signup
• http method: POST
• 요청 헤더

Content-Type: application/json;charset=UTF-8

• request_body

{
    "email": "[email protected]",
    "password": "password",
    "nickname": "testuser"
}

• 성공 응답

201 CREATED
{
  "id": "1" ; 생성 id
}

로그인

• api: /signin
• http method: POST
• 요청 헤더

Content-Type: application/json;charset=UTF-8

• request_body

{
    "email": "[email protected]",
    "password": "password",
}

• 성공 응답

200 OK

로그아웃

• api: /logout
• http method: POST
• 요청 헤더

Content-Type: application/json;charset=UTF-8

• request_body

{
}

• 성공 응답

200 OK

카테고리 API

카테고리 조회

• api: /category/{category_id}
• http method: GET
• 요청 헤더

Content-Type: application/json;charset=UTF-8

카테고리 생성

• api: /category
• http method: POST
• 요청 헤더

Content-Type: application/json;charset=UTF-8
Authorization: "bearer <토큰>"

• request_body

{
    "name": "",
    "parentId": 0L
}

카테고리 수정

• api: /category/{category_id}
• http method: PUT
• 요청 헤더

Content-Type: application/json;charset=UTF-8
Authorization: "bearer <토큰>"

• request_body

{
    "name": "",
    "parentId": ""
}

카테고리 삭제

• api: /category/{category_id}
• http method: DELETE
• 요청 헤더

Content-Type: application/json;charset=UTF-8
Authorization: "bearer <토큰>"

커뮤니티 피드 게시판 API

커뮤니티 게시판 조회

• api: /board
• http method: GET
• 요청 헤더

Content-Type: application/json;charset=UTF-8

커뮤니티 회원별 게시판 조회

• api: /board/{account_id}
• http method: GET
• 요청 헤더

Content-Type: application/json;charset=UTF-8

커뮤니티 특정 게시물 조회

• api: /board/{board_id}
• http method: GET
• 요청 헤더

Content-Type: application/json;charset=UTF-8

커뮤니티 게시물 작성

• api: /board
• http method: POST
• 요청 헤더

Content-Type: application/json;charset=UTF-8
Authorization: "bearer <토큰>"

• request_body

{
    "content": "",
    "account": {}
}

커뮤니티 게시물 수정

• api: /board/{board_id}
• http method: PUT
• 요청 헤더

Content-Type: application/json;charset=UTF-8
Authorization: "bearer <토큰>"

• request_body

{
    "content": "",
}

커뮤니티 게시물 삭제

• api: /board/{board_id}
• http method: DELETE
• 요청 헤더

Content-Type: application/json;charset=UTF-8
Authorization: "bearer <토큰>"