API 명세

Webtoon APIs

GET - /api/webtoon

• 웹툰 탭의 메인페이지
• 웹툰 인기순
• parameters
  • pno : 가져올 데이터의 페이지 번호
  • count : 메인페이지에 담길(한 페이지의)데이터 갯수

GET - /api/webtoon/{webtoon-id}

• 웹툰의 상세 조회
• 관련 리뷰, 관련 서재 포함
• path variables
  • webtoon-id : 상세 조회할 웹툰의 아이디
• parameters
  • pno : 가져올 리뷰 또는 서재 데이터의 페이지 번호
  • count : 가져올 리뷰 또는 서재 데이터의 갯수

GET - /api/webtoon/all

• 웹툰 리스트 모두 보기
• 웹툰 제목순
• parameters
  • pno : 가져올 데이터의 페이지 번호
  • count : 가져올 데이터의 갯수

GET - /api/webtoon/all/{genre}

• 웹툰 장르별 리스트 보기
• 웹툰 제목순
• path variables
  • genre : 조회할 장르명 텍스트로
• parameters
  • pno : 가져올 데이터의 페이지 번호
  • count : 가져올 데이터의 갯수

GET - /api/webtoon/tag-search/{tag-id}

• 웹툰 태그별 보기
• 웹툰 제목순
• path variables
  • tag-id : 조회할 태그의 아이디(식별자) 값
• parameters
  • pno : 가져올 데이터의 페이지 번호
  • count : 가져올 데이터의 갯수

GET - /api/webtoon/{webtoon-id}/like

• 웹툰에 좋아요가 눌렸는지 확인
• path variables
  • webtoon-id : 좋아요가 눌린 웹툰의 아이디(식별자) 값

POST - /api/webtoon/{webtoon-id}/like

• 웹툰에 좋아요 누르기
• path variables
  • webtoon-id : 좋아요가 눌린 웹툰의 아이디(식별자) 값

DELETE - /api/webtoon/{webtoon-id}/like

• 웹툰에 좋아요 취소
• path variables
  • webtoon-id : 좋아요를 취소할 웹툰의 아이디(식별자) 값
    
    
    
    

Review APIs

GET - /api/reivew/{webtoon-id}

• 특정웹툰에 달린 리뷰 전체 조회
• path variables
  • webtoon-id : 조회할 리뷰들이 달린 웹툰의 아이디(식별자) 값
• parameters
  • pno : 가져올 데이터의 페이지 번호
    • count : 가져올 데이터의 갯수

POST - /api/review/{webtoon-id}

• 리뷰 작성
• path variables
  • webtoon-id : 리뷰가 작성된 웹툰의 아이디(식별자) 값
• request body
  • title : 리뷰 제목
  • content : 리뷰 내용
  • drawingScore : 작화 평점
  • storyScore : 스토리 평점
  • directingScore : 연출 평점

DELETE - /api/review/{review-id}

• 리뷰 삭제
• path variable
  • review-id : 삭제할 리뷰 아이디(식별자) 값

PATCH - /api/review/{review-id}

• 리뷰 수정
• path variable
  • review-id : 수정할 리뷰의 아이디(식별자) 값
• request body
  • title : 리뷰 제목
  • content : 리뷰 내용
  • drawingScore : 작화 평점
  • storyScore : 스토리 평점
  • directingScore : 연출 평점

GET - /api/review/my

• 자신이 남긴 리뷰 조회
• parameters
  • pno : 가져올 데이터의 페이지 번호
  • count : 가져올 데이터의 갯수
    
    
    
    

Library APIs

GET - /api/library/hot

• 인기 서재 조회
• parameters
  • pno : 가져올 데이터의 페이지 번호
  • count : 가져올 데이터의 갯수

GET - /api/library

• 자신의 서재 목록을 조회

POST - /api/library

• 자신의 서재 추가
• 한 유저당 서재 20개까지 생성
• request body
  • name : 서재의 제목

GET - /api/library/{library-id}

• 서재 상세 조회
• 서재에 포함된 웹툰 조회
• path variables
  • library-id : 조회할 서재의 아이디(식별자) 값

POST - /api/library/{library-id}

• 서재에 웹툰 추가
• path variables
  • library-id : 웹툰이 추가될 서재의 아이디(식별자) 값
• request body
  • webtoonId : 서재에 추가할 웹툰의 아이디(식별자) 값

DELETE - /api/library/{library-id}/{webtoon-id}

• 서재에 웹툰 삭제
• path variables
  • library-id : 웹툰을 삭제할 서재의 아이디(식별자) 값
  • webtoon-id : 서재에서 삭제할 웹툰의 아이디(식별자) 값

DELETE - api/library/{library-id}

• 서재 삭제
• path variables
  • library-id : 삭제할 서재의 아이디(식별자) 값

PATCH - /api/library/{library-id}

• 서재 이름 수정
• path variables
  • library-id : 수정할 서재의 아이디(식별자) 값

GET - /api/library/subscription

• 구독 중인 서재 리스트 조회
• parameters
  • pno : 가져올 데이터의 페이지 번호
  • count : 가져올 데이터의 갯수

POST - /api/library/subscription

• 서재 구독
• request body
  • libraryId : 구독할 서재의 아이디(식별자) 값

DELETE - /api/library/subscription

• 서재 구독 취소
• request body
  • libraryId : 구독 취소할 서재의 아이디(식별자) 값
    
    
    
    

Chatting APIs

WS - /api/chat/{webtoon-id}

• 채팅
• path variables
  • webtoon-id : 채팅방이 위치한 웹툰의 아이디

GET - /api/history/{webtoon-id}

• 채팅 기록 조회
• path variables
  • webtoon-id : 채팅 방이 위치한 웹툰의 아이디
• parameters
  • start : 가져올 기록 데이터의 시작 일시
  • end : 가져올 기록 데이터의 종료 일시
    
    
    
    

Recommend API

GET - /api/recommend

• 추천 조회
• 사용자의 리뷰에 기반하여 웹툰을 추천한다.
  
  
  
  

Article APIs

GET - /api/board

• 게시글 전체 조회
• parameters
  • pno : 가져올 데이터의 페이지 번호
  • count : 가져올 데이터의 갯수

GET - /api/board/{id}

• 게시글 단일 조회
• parameters
  • id : 게시글 아이디(식별자)

POST - /api/board

• 게시글 생성
• Request Body

{
  "title": "string",
  "content": "string",
  "articleTagList": [
    {
      "tag": "string"
    }
  ]
}

PATCH - /api/board

• 게시글 수정
• Request Body

{
  "title": "string",
  "content": "string",
  "id": 0
}

DELETE - /api/board/{id}

• 게시글 삭제
• parameters
  • id: 게시글 id(식별자)

GET- /api/board/search

• 게시글 삭제
• parameters
  • keyword: 검색 키워드

GET- /api/board/my

• 내가 작성한 게시글 리스트 조회
• parameters
  • pno : 가져올 데이터의 페이지 번호
  • count : 가져올 데이터의 갯수

GET- /api/board/count

• 게시글 전체 개수 조회

Comment APIs

GET- /api/board/{articleId}/comment

• 해당 게시글에 달린 모든 댓글을 조회
• parameters
  • articleId : 게시글 아이디(식별자)

POST- /api/board/{articleId}/comment

• 해당 게시글에 댓글을 작성
• parameters
  • articleId : 게시글 아이디(식별자)
• Request Body

{
  "content": "string",
  "group": 0, 
  "article": {
    "id": articleId
  }
}

댓글은 id를 가지며, 대댓글은 group 값으로 댓글의 id를 가집니다. 부모댓글의 group 값은 0입니다.

GET- /api/board/comment/my

• 내가 작성한 댓글들을 조회
• parameters
  • pno : 가져올 데이터의 페이지 번호
  • count : 가져올 데이터의 갯수

GET- /api/board/{articleId}/comment/{commentId}

• 댓글을 삭제
• parameters
  • commentId: 댓글 아이디(식별자)

Search APIs

GET- /api/search/webtoon

• 웹툰 검색
• parameters
  • keyword: 검색 키워드

GET- /api/search/webtoon/title

• 웹툰 검색
• parameters
  • keyword: 검색 키워드

User APIs

POST- /api/user/login

• 로그인
• Request Body

{
    "username":"string",
    "password":"string",
}

POST- /api/user/signup

• 회원가입
• Request Body

{
    "username":"string",
    "password":"string",
    "nickname":"string",
}