search

TreeNut-KR / ChatBot

ChatBot 웹사이트 프로젝트
GNU General Public License v3.0
1 stars 0 forks source link

SpringBoot API 명세서 #16

Open CutTheWire opened 2 months ago

CutTheWire commented 2 months ago

[POST] /server/user/register

  1. 업무 : 로컬 회원가입
  2. 담당자 : 김준건

REQ

body

{
    "id" : "test",
    "pw" : "test1234",
    "email" : "test@gmail.com",
    "name" : "test"
}
변수명 변수형
id string
pw string
email string
name string

RES

body

{
    "status" : 200,
    "token" : ...,
    "name" : "test"
}
변수명 변수형
status int
token string
name string

[POST] /server/user/login

  1. 업무 : 로컬 로그인
  2. 담당자 : 김준건

REQ

body

{
    "id" : "test",
    "pw" : "test1234"
}
변수명 변수형
id string
pw string

RES

body

{
    "token" : ...,
    "name" : "test"
}
변수명 변수형
token string
name string

[POST] /server/user/register/social

  1. 업무 : 소셜 회원가입
  2. 담당자 : 오동현

REQ

body

{
    "access_token" : ...,
    "name" : "test"
}
변수명 변수형
access_token string
name string

RES

body

{
    "token" : ...,
    "name" : "test"
}
변수명 변수형
token string
name string

[POST] /server/user/login/social

  1. 업무 : 소셜 로그인
  2. 담당자 : 오동현

REQ

body

{
    "token" : ...
}
변수명 변수형
token string

RES

body

{
    "token" : ...,
    "name" : "test"
}
변수명 변수형
token string
name string

[POST] /server/user/login/callBack

  1. 업무 : 자동로그인, 페이지 로드시 자동 실행
  2. 담당자 : 오동현

REQ

body

{
    "token" : ...
}
변수명 변수형
token string

RES

body

{
    "token" : ...,
    "name" : "test"
}
변수명 변수형
token string
name string

[DELETE] /server/user/delete/{userid}

  1. 업무 : 회원 탈퇴
  2. 담당자 : 권재현

REQ

body

header

{
    "authorization" : "로그인 시 생성되는 jwt 토큰 값"
}
변수명 변수형
authorization string

RES

body

{
      "status": 200,
      "message": "User deleted successfully"
    }

[GET] /server/chatroom/list

  1. 업무 : 채팅방 목록 보기
  2. 담당자 : 서정훈

[POST] /server/character/add

  1. 업무 : 캐릭터 모델 생성
  2. 담당자 : @모현준 , @JoonHo Lee

REQ

body

#header
{
    "authorization" : ...
}
#body
{
    "character_name" : "test",
    "description" : "test characters" ,
    "greeting" : "hello",
    "image" : "http://example.com/image.jpg" ,
    "character_setting" : "test setting",
    "accessLevel" : true
}
변수명 변수형
authorization string
characterName string
description string
greeting string
image string
character_setting string
accessLevel boolean

RES

body

# Headers

# body
{
    status : 200 # 성공시 코드 200번대 반환
    name : 테스트 캐릭터 
}

[POST] /server/character/addimage

  1. 업무 : 캐릭터 모델 이미지 업로드
  2. 담당자 : @JoonHo Lee

REQ

body

이미지 업로드를 위해 form-data 형식으로 해야 함 변수명 변수형
file 이미지파일

RES

body

# Headers

# body
{
    status : int # 성공시 코드 200번대 반환,
    "url" : "image URL"
}

[PUT] /server/character/edit?characterName=test

  1. 업무 : 캐릭터 모델 수정
  2. 담당자 : @모현준 , @JoonHo Lee

REQ

# Headers
{
    authorization : token
}
# body
{
    "character_name" : "edit test",
    "description" : "edit test character",
    "greeting" : "hello edit test",
    "image" : "http://example.com/editimage.jpg",
    "character_setting" : "edit test setting",
    "accessLevel" : false
}
    //추후 카테고리, 태그 기능 추가

# body
변수명 변수형
authorization string
characterName str
description str
greeting str
image str
character_setting str
accessLevel boolean

RES

# Headers

# body
{
    "status": 200,
    "message": "Character updated successfully"
}

[DELETE] /server/character/delete?characterName=test

  1. 업무 : 캐릭터 모델 삭제
  2. 담당 : @모현준 , @JoonHo Lee

REQ

# Headers
{
    authorization : token
}

# body

RES

# Headers

# body
{
    status : int # 성공시 코드 200번대 반환
    "message": "Character updated successfully"
}

[GET] /server/character/OpenCharacterList

  1. 업무 : 캐릭터 모델 조회
  2. 담당 : @모현준 , @JoonHo Lee

REQ

# Headers
{
    authorization : token
}

# body

RES

# Headers

# body
{
    {
        "characterName": "test",
        "userid": "test",
        "description": "test characters",
        "image": "http://example.com/editimage.jpg"
    },
        ...
}

accessLevel이 1인 캐릭터만 반환

[GET] /server/character/MyCharacterList

  1. 업무 : 캐릭터 모델 조회
  2. 담당 : @모현준 , @JoonHo Lee

REQ

# Headers
{
    authorization : token
}

# body

RES

# Headers

# body
{
    {
        "characterName": "test",
        "userid": "test",
        "description": "test characters",
        "image": "http://example.com/editimage.jpg"
    },
        ...
}

userid가 token의 유저명과 같은 캐릭터 반환

[GET] /server/character/search?CharacterName=test

  1. 업무 : 캐릭터 모델 조회
  2. 담당 : @모현준 , @JoonHo Lee

REQ

# Headers

# body

RES

# Headers

# body
{
    {
        "characterName": "test",
        "userid": "test",
        "description": "test characters",
        "image": "http://example.com/editimage.jpg"
    },
        ...
}

userid가 token의 유저명과 같은 캐릭터 반환

[POST] /server/chatroom/office

  1. 업무 : office 채팅방 생성
  2. 담당자 : 권재현

REQ

headers

"authorization" :  "로그인 시 생성되는 jwt 토큰 값"

body

{
    "input_data_set" : "채팅내용"
}
변수명 변수형
authorization string
input_data_set string

RES

headers

body

{
  "status": 200,
  "message": "채팅방이 성공적으로 생성되었고 로그가 저장되었습니다.",
  "add_log_response": "추가된 로그 응답",
  "mysql_officeroom": "MySQL에 저장된 채팅방 데이터"
}

[POST] /server/chatroom/office/{채팅방id}/load_logs

  1. 업무 : office 채팅로그 불러오기
  2. 담당자 : 권재현

REQ

headers

"authorization" :  "로그인 시 생성되는 jwt 토큰 값"

body

변수명 변수형
authorization string

RES

headers

body

{
  "status": 200,
  "logs": "불러온 로그 데이터"
}

[PUT] /server/chatroom/office/{채팅방id}/save_log

  1. 업무 : office 채팅 저장
  2. 담당자 : 권재현

REQ

headers

"authorization" :  "로그인 시 생성되는 jwt 토큰 값"

body

{
    "input_data_set": "채팅 내용"
}
변수명 변수형
authorization string
input_data_set string

RES

headers

body

{
  "status": 200,
  "message": "채팅 로그가 성공적으로 저장되었습니다.",
  "response": "저장된 응답"
}

[PUT] /server/chatroom/office/{채팅방id}/update_log

  1. 업무 : office 채팅 수정
  2. 담당자 : 권재현

REQ

headers

"authorization" :  "로그인 시 생성되는 jwt 토큰 값"

body

{
    "input_data_set": "채팅 내용",
    "index" : 수정을 원하는 인덱스 번호
}
변수명 변수형
authorization string
input_data_set string
index int

RES

headers

body

{
  "status": 200,
  "message": "채팅 로그가 성공적으로 수정되었습니다.",
  "response": "수정된 응답"
}

[DELETE] /server/chatroom/office/{채팅방id}/delete_room

  1. 업무 : office 채팅방 삭제
  2. 담당자 : 권재현

REQ

headers

"authorization" :  "로그인 시 생성되는 jwt 토큰 값"

body

변수명 변수형
authorization string

RES

headers

body

{
  "status": 200,
  "message": "채팅방이 성공적으로 삭제되었습니다.",
  "response": "삭제 응답"
}

[DELETE] /server/chatroom/office/{채팅방id}/delete_log?index=삭제 인덱스 번호

  1. 업무 : office 채팅 로그 삭제
  2. 담당자 : 권재현

REQ

headers

"authorization" :  "로그인 시 생성되는 jwt 토큰 값"

body

변수명 변수형
authorization string

RES

headers

body

{
  "status": 200,
  "message": "해당 로그가 성공적으로 삭제되었습니다.",
  "response": "삭제된 응답"
}
qwer9679 commented 2 months ago

Character/add POST로 변경

qwer9679 commented 2 months ago

springboot - mysql 변수명 다른 부분(greeting/greetings) 수정