04_API_DOCS - GeulReadyEditor/onego GitHub Wiki

Content

객체 설명

Board

Variable Type Variable Name
String id
String email
String nickName
String title
String subitle
String titleImage
int likes
Date modDatetime
List<Content> contents
List<Comment> comments
List<String> tags

TempBoard

Variable Type Variable Name
String id
String email
String title
String subitle
String titleImage
Date modDatetime
List<Content> contents
List<Memo> memos
List<String> tags

Content

Variable Type Variable Name
int no
String title
String subitle
String content

Comment

Variable Type Variable Name
String id
String email
String nickName
String comment
Date modDatetime

Memo

Variable Type Variable Name
int no
String memo

User

Variable Type Variable Name
String userId
String email
String nickName
String intro
String profileImage
List<String> scraps
List<String> likes
List<String> followers
List<String> followings
List<String> tags

TempBoard API

Method Path Parameter 설명 Request Field Response Field
GET /tempBoard 한 페이지당 최대 5개의 tempBoard 데이터를 불러온다 {
 userEmail:String,
 pageNumber:int
}		 List<tempBoard>
GET /tempBoard tempBoardId에 대응되는 특정 tempBoard 데이터를 불러온다 {
 tempBoardId:String,
}		 List<tempBoard>
GET /tempBoard/count tempBoardId에 대응되는 tempBoard 갯수를 불러온다 {
 userEmail:String,
}		 List<tempBoard>
POST /tempBoard tempBoard를 저장 하고 생성한 tempBoardId를 받는다. {
 tempBoard
(id 입력x)
}		 tempBoardId:String
POST /tempBoard tempBoard를 수정 하고 갱신한 tempBoardId를 받는다. {
 tempBoard
}		 tempBoardId:String
DELETE /tempBoard tempBoard를 삭제한다. {
 boardIdx:String
}		 boolean

Board&Comment API

Method Path Parameter 설명 Request Field Response Field
GET /board 한 페이지당 최대 5개의 board 데이터를 불러온다, boardId로 검색시 길이가 1인 List<temp_board>를 반환. message body의 parameter에 따라 각각 검색 가능 {
  boardId:String,
  userEmail:String,
  title:String,
  nickName:String,
  tag:String ,
  (*필수)pageNumber:Int
}		 List<board>
GET /board/count 검색시(title,nickName,tag 각각을 이용한 검색가능, 전부 null일 경우 전체 board반환) 페이징을 위한 총 board의 갯수를 반환 {
  title:String,
 nickName:String,
 tag:String
}		 Number
POST /board 작성 중인 글을 포스팅한다. {
  userEmail:String,
  nickName:String,
  title:String,
  subtitle:String,
  titleImageFile:MultipartFile,   contents:List<Content>,
  tags:List<String>
}		 boolean
PUT /board 포스트된 글을 수정한다. {
 boardId:String,
  title:String,
  subtitle:String,
  titleImageFile:MultipartFile,   contents:List<Content>,
  tags:List<String>
}		 boolean
DELETE /board 포스트 글을 삭제한다. {
 boardId:String
}		 boolean
GET /comment 포스트의 댓글을 10개씩 한 페이지를 가져온다. {
 boardId:String,
 pageNumber:Int
}		 List<comment>
POST /comment 포스트의 댓글을 등록한다. {
 boardId:String,
 userEmail:String,
 nickName:String,
 comment:String
}		 boolean
PUT /comment 포스트의 댓글을 수정한다. {
 boardId:String,
 commentId:String,
 userEmail:String,
 nickName:String,
 comment:String
}		 boolean
DELETE /comment 포스트의 댓글을 삭제한다. {
 boardId:String,
 commentId:String
}		 boolean

User

Method Path Parameter 설명 Request Field Response Field
GET /users/{email} 사용자 정보를 가져온다 {
 email:String
}		 user
POST /users 사용자 정보를 저장한다 {
 email:String,
 nickname:String,
 intro:String
}		 boolean
PUT /users/{email} 사용자 정보를 수정한다,
개별 수정 가능		 {
 nickname:String,
 intro:String,
 profileImageFile:MultipartFile,
 tag:String
}		 boolean
DELETE /users/{email} 사용자 삭제한다 {
 email:String
}		 boolean



Follow

Method Path Parameter 설명 Request Field Response Field
GET /followers/{email} 사용자 follower 목록을 가져온다 {} List<String>
GET /followings/{email} 사용자 following 목록을 가져온다 {} List<String>
POST /followings/{email} email의 following 목록에 followrEmail을 추가하고 followEmail의 follower목록에 email을 추가한다 {
 followEmail:String
}		 boolean
DELETE /followings/{email} email의 following 목록에 followrEmail을 삭제하고 followEmail의 follower목록에 email을 삭제한다 {
 followEmail:String
}		 boolean





Like

Method Path Parameter 설명 Request Field Response Field
POST /{boardId} 게시글에 좋아요 버튼을 누르면, 게시글의 좋아요 count가 1 증가하고 user의 좋아요 글 목록에 게시글이 추가된다. {
 userEmail:String
}		 boardLikes:int
POST /{boardId} 좋아요 버튼을 누른 게시글에 좋아요 버튼을 다시 누르면, 게시글의 좋아요 count가 1 감소하고 user의 좋아요 글 목록에 해당 게시글이 삭제된다. {
 userEmail:String
}		 boardLikes:int



⚠️ **GitHub.com Fallback** ⚠️