From 3b4465a67208004463a2a9ce3c208fb0ae7055ec Mon Sep 17 00:00:00 2001 From: j-yong99 Date: Thu, 11 Apr 2024 20:54:14 +0900 Subject: [PATCH] =?UTF-8?q?:sparkles:=20gateway=EC=97=90=20=EB=9D=84?= =?UTF-8?q?=EC=9A=B8=20=EC=B5=9C=EC=A2=85=20html=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../src/main/resources/static/docs/index.html | 3057 +++++++++++++++++ 1 file changed, 3057 insertions(+) create mode 100644 backend/moment/moment-server/gateway/src/main/resources/static/docs/index.html diff --git a/backend/moment/moment-server/gateway/src/main/resources/static/docs/index.html b/backend/moment/moment-server/gateway/src/main/resources/static/docs/index.html new file mode 100644 index 0000000000..75a81c2a25 --- /dev/null +++ b/backend/moment/moment-server/gateway/src/main/resources/static/docs/index.html @@ -0,0 +1,3057 @@ + + + + + + + +Moment Application API Document + + + + + + +
+
+

AlreadyBookedDate

+
+
+

예약일 전부 조회

+
+

HTTP request

+
+
+
GET /core/alreadyBookedDate/all HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+userId: 1
+Host: localhost:8080
+
+
+
+
+

Request headers

+ ++++ + + + + + + + + + + + + +
NameDescription

userId

Bearer Token

+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 211
+
+{
+  "status" : 200,
+  "code" : "200",
+  "msg" : "SELECT SUCCESS",
+  "detailMsg" : "",
+  "data" : {
+    "cardViews" : [ {
+      "bookedDate" : "2024-04-11"
+    }, {
+      "bookedDate" : "2023-10-10"
+    } ]
+  }
+}
+
+
+
+
+

Response fields

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PathTypeDescription

status

Number

응답 상태 코드

code

String

응답 코드

msg

String

응답 메시지

detailMsg

String

상세 메시지

data.cardViews[].bookedDate

String

예약된 날짜 목록

+
+
+
+
+
+

CardView

+
+
+

녹음본 업로드

+
+

HTTP request

+
+
+
POST /core/cardView/upload HTTP/1.1
+Content-Type: multipart/form-data;charset=UTF-8; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
+userId: 1
+Host: localhost:8080
+
+--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
+Content-Disposition: form-data; name=recordFile; filename=test.mp3
+Content-Type: audio/mp3
+
+test
+--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
+Content-Disposition: form-data; name=uploadRecord
+Content-Type: application/json
+
+{
+  "location": "서울",
+  "recordedAt": "2024-02-08T14:30:00",
+  "temperature": "20",
+  "weather": "맑음",
+  "question": "질문"
+}
+--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
+
+
+
+
+

Request headers

+ ++++ + + + + + + + + + + + + +
NameDescription

userId

Bearer Token

+
+
+

Request part-uploadrecord-fields

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PathTypeDescription

location

String

녹음본 장소

recordedAt

String

녹음 시점

temperature

String

온도

weather

String

날씨

question

String

질문

+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 549
+
+{
+  "status" : 201,
+  "code" : "201",
+  "msg" : "INSERT SUCCESS",
+  "detailMsg" : "",
+  "data" : {
+    "tripFileId" : 1,
+    "recordedAt" : "2024-02-08T14:30:00",
+    "recordFileName" : "test.mp3",
+    "recordFileUrl" : "http://localhost:8080/",
+    "location" : "서울",
+    "recordFileLength" : 100,
+    "weather" : "맑음",
+    "temperature" : "20",
+    "stt" : "test",
+    "happy" : 0.1,
+    "sad" : 0.1,
+    "angry" : 0.1,
+    "neutral" : 0.1,
+    "question" : "질문",
+    "recordFileStatus" : "WAIT",
+    "id" : 1,
+    "loved" : true
+  }
+}
+
+
+
+
+

Response fields

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PathTypeDescription

status

Number

응답 상태 코드

code

String

응답 코드

msg

String

응답 메시지

detailMsg

String

상세 메시지

data.id

Number

cardView ID

data.tripFileId

Number

tripFile ID

data.recordedAt

String

녹음 시점

data.recordFileName

String

파일이름

data.recordFileUrl

String

파일 저장 위치

data.location

String

위치

data.recordFileLength

Number

파일길이

data.weather

String

날씨

data.temperature

String

온도

data.stt

String

STT

data.happy

Number

기쁨

data.sad

Number

슬픔

data.angry

Number

화남

data.neutral

Number

중립

data.question

String

질문

data.loved

Boolean

즐겨찾기

data.recordFileStatus

String

분석 상태

+
+
+
+

카드뷰 삭제

+
+

HTTP request

+
+
+
DELETE /core/cardView/1 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+userId: 1
+Host: localhost:8080
+
+
+
+
+

Request headers

+ ++++ + + + + + + + + + + + + +
NameDescription

userId

Bearer Token

+
+
+

Path parameters

+ + ++++ + + + + + + + + + + + + +
Table 1. /core/cardView/{cardViewId}
ParameterDescription

cardViewId

카드뷰 ID

+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 102
+
+{
+  "status" : 200,
+  "code" : "200",
+  "msg" : "DELETE SUCCESS",
+  "detailMsg" : "",
+  "data" : { }
+}
+
+
+
+
+

Response fields

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PathTypeDescription

status

Number

응답 상태 코드

code

String

응답 코드

msg

String

응답 메시지

detailMsg

String

상세 메시지

data

Object

데이터 없음

+
+
+
+

여행파일ID로 카드뷰 전체 조회

+
+

HTTP request

+
+
+
GET /core/cardView/all/1 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+userId: 1
+Host: localhost:8080
+
+
+
+
+

Request headers

+ ++++ + + + + + + + + + + + + +
NameDescription

userId

Bearer Token

+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 1102
+
+{
+  "status" : 200,
+  "code" : "200",
+  "msg" : "SELECT SUCCESS",
+  "detailMsg" : "",
+  "data" : {
+    "cardViews" : [ {
+      "tripFileId" : 1,
+      "recordedAt" : "2024-02-08T14:30:00",
+      "recordFileName" : "test.mp3",
+      "recordFileUrl" : "http://localhost:8080/",
+      "location" : "서울",
+      "recordFileLength" : 100,
+      "weather" : "맑음",
+      "temperature" : "20",
+      "stt" : "test",
+      "happy" : 0.1,
+      "sad" : 0.1,
+      "angry" : 0.1,
+      "neutral" : 0.1,
+      "question" : "질문",
+      "recordFileStatus" : "WAIT",
+      "id" : 1,
+      "loved" : true
+    }, {
+      "tripFileId" : 1,
+      "recordedAt" : "2024-02-08T15:30:00",
+      "recordFileName" : "test.mp3",
+      "recordFileUrl" : "http://localhost:8080/",
+      "location" : "서울",
+      "recordFileLength" : 100,
+      "weather" : "맑음",
+      "temperature" : "20",
+      "stt" : "test",
+      "happy" : 0.1,
+      "sad" : 0.1,
+      "angry" : 0.1,
+      "neutral" : 0.1,
+      "question" : "질문",
+      "recordFileStatus" : "WAIT",
+      "id" : 2,
+      "loved" : false
+    } ]
+  }
+}
+
+
+
+
+

Response fields

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PathTypeDescription

status

Number

응답 상태 코드

code

String

응답 코드

msg

String

응답 메시지

detailMsg

String

상세 메시지

data.cardViews[].id

Number

cardView ID

data.cardViews[].tripFileId

Number

tripFile ID

data.cardViews[].recordedAt

String

녹음 시점

data.cardViews[].recordFileName

String

파일이름

data.cardViews[].recordFileUrl

String

파일 저장 위치

data.cardViews[].location

String

위치

data.cardViews[].recordFileLength

Number

파일길이

data.cardViews[].weather

String

날씨

data.cardViews[].temperature

String

온도

data.cardViews[].stt

String

STT

data.cardViews[].happy

Number

기쁨

data.cardViews[].sad

Number

슬픔

data.cardViews[].angry

Number

화남

data.cardViews[].neutral

Number

중립

data.cardViews[].question

String

질문

data.cardViews[].loved

Boolean

즐겨찾기

data.cardViews[].recordFileStatus

String

분석 상태

+
+
+
+

카드뷰 수정

+
+

HTTP request

+
+
+
PUT /core/cardView/1 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+userId: 1
+Content-Length: 118
+Host: localhost:8080
+
+{
+  "location" : "서울",
+  "weather" : "맑음",
+  "temperature" : "20",
+  "question" : "질문",
+  "stt" : "test"
+}
+
+
+
+
+

Request headers

+ ++++ + + + + + + + + + + + + +
NameDescription

userId

Bearer Token

+
+
+

Path parameters

+ + ++++ + + + + + + + + + + + + +
Table 1. /core/cardView/{cardViewId}
ParameterDescription

cardViewId

카드뷰 ID

+
+
+

Request body

+
+
+
{
+  "location" : "서울",
+  "weather" : "맑음",
+  "temperature" : "20",
+  "question" : "질문",
+  "stt" : "test"
+}
+
+
+
+
+

Request fields

+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
필드명타입필수값양식설명

location

String

true

녹음본 장소

weather

String

true

날씨

temperature

String

true

온도

question

String

true

질문

stt

String

true

STT

+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 102
+
+{
+  "status" : 200,
+  "code" : "200",
+  "msg" : "UPDATE SUCCESS",
+  "detailMsg" : "",
+  "data" : { }
+}
+
+
+
+
+

Response fields

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PathTypeDescription

status

Number

응답 상태 코드

code

String

응답 코드

msg

String

응답 메시지

detailMsg

String

상세 메시지

data

Object

데이터 없음

+
+
+
+

카드뷰 좋아요 누르기

+
+

HTTP request

+
+
+
PUT /core/cardView/like/1 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+userId: 1
+Host: localhost:8080
+
+
+
+
+

Request headers

+ ++++ + + + + + + + + + + + + +
NameDescription

userId

Bearer Token

+
+
+

Path parameters

+ + ++++ + + + + + + + + + + + + +
Table 1. /core/cardView/like/{cardViewId}
ParameterDescription

cardViewId

카드뷰 ID

+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 102
+
+{
+  "status" : 200,
+  "code" : "200",
+  "msg" : "UPDATE SUCCESS",
+  "detailMsg" : "",
+  "data" : { }
+}
+
+
+
+
+

Response fields

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PathTypeDescription

status

Number

응답 상태 코드

code

String

응답 코드

msg

String

응답 메시지

detailMsg

String

상세 메시지

data

Object

데이터 없음

+
+
+
+

좋아요 상태의 카드뷰 조회

+
+

HTTP request

+
+
+
GET /core/cardView/like HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+userId: 1
+Host: localhost:8080
+
+
+
+
+

Request headers

+ ++++ + + + + + + + + + + + + +
NameDescription

userId

Bearer Token

+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 1102
+
+{
+  "status" : 200,
+  "code" : "200",
+  "msg" : "SELECT SUCCESS",
+  "detailMsg" : "",
+  "data" : {
+    "cardViews" : [ {
+      "tripFileId" : 1,
+      "recordedAt" : "2024-02-08T14:30:00",
+      "recordFileName" : "test.mp3",
+      "recordFileUrl" : "http://localhost:8080/",
+      "location" : "서울",
+      "recordFileLength" : 100,
+      "weather" : "맑음",
+      "temperature" : "20",
+      "stt" : "test",
+      "happy" : 0.1,
+      "sad" : 0.1,
+      "angry" : 0.1,
+      "neutral" : 0.1,
+      "question" : "질문",
+      "recordFileStatus" : "WAIT",
+      "id" : 1,
+      "loved" : true
+    }, {
+      "tripFileId" : 1,
+      "recordedAt" : "2024-02-08T15:30:00",
+      "recordFileName" : "test.mp3",
+      "recordFileUrl" : "http://localhost:8080/",
+      "location" : "서울",
+      "recordFileLength" : 100,
+      "weather" : "맑음",
+      "temperature" : "20",
+      "stt" : "test",
+      "happy" : 0.1,
+      "sad" : 0.1,
+      "angry" : 0.1,
+      "neutral" : 0.1,
+      "question" : "질문",
+      "recordFileStatus" : "WAIT",
+      "id" : 2,
+      "loved" : false
+    } ]
+  }
+}
+
+
+
+
+

Response fields

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PathTypeDescription

status

Number

응답 상태 코드

code

String

응답 코드

msg

String

응답 메시지

detailMsg

String

상세 메시지

data.cardViews[].id

Number

cardView ID

data.cardViews[].tripFileId

Number

tripFile ID

data.cardViews[].recordedAt

String

녹음 시점

data.cardViews[].recordFileName

String

파일이름

data.cardViews[].recordFileUrl

String

파일 저장 위치

data.cardViews[].location

String

위치

data.cardViews[].recordFileLength

Number

파일길이

data.cardViews[].weather

String

날씨

data.cardViews[].temperature

String

온도

data.cardViews[].stt

String

STT

data.cardViews[].happy

Number

기쁨

data.cardViews[].sad

Number

슬픔

data.cardViews[].angry

Number

화남

data.cardViews[].neutral

Number

중립

data.cardViews[].question

String

질문

data.cardViews[].loved

Boolean

즐겨찾기

data.cardViews[].recordFileStatus

String

분석 상태

+
+
+
+
+
+

Auth

+
+
+

로그인

+
+

HTTP request

+
+
+
POST /auth/login HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Content-Length: 58
+Host: localhost:8080
+
+{
+  "email" : "alexj99@naver.com",
+  "password" : "1234"
+}
+
+
+
+
+

Request body

+
+
+
{
+  "email" : "alexj99@naver.com",
+  "password" : "1234"
+}
+
+
+
+
+

Request fields

+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
필드명타입필수값양식설명

email

String

true

이메일

password

String

true

비밀번호

+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 229
+
+{
+  "status" : 200,
+  "code" : "200",
+  "msg" : "SELECT SUCCESS",
+  "detailMsg" : "",
+  "data" : {
+    "grantType" : "Bearer",
+    "accessToken" : "accessToken",
+    "refreshToken" : "refresh",
+    "role" : "ROLE_AUTH_USER"
+  }
+}
+
+
+
+
+

Response fields

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PathTypeDescription

status

Number

응답 상태 코드

code

String

응답 코드

msg

String

응답 메시지

detailMsg

String

상세 메시지

data.grantType

String

토큰 타입

data.accessToken

String

액세스 토큰

data.refreshToken

String

리프레시 토큰

data.role

String

사용자 권한

+
+
+
+

비밀번호 변경

+
+

HTTP request

+
+
+
PATCH /auth/password HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+userId: 1
+Content-Length: 48
+Host: localhost:8080
+
+{
+  "code" : "1234",
+  "newPassword" : "12345"
+}
+
+
+
+
+

Request headers

+ ++++ + + + + + + + + + + + + +
NameDescription

userId

Bearer Token

+
+
+

Request body

+
+
+
{
+  "code" : "1234",
+  "newPassword" : "12345"
+}
+
+
+
+
+

Request fields

+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
필드명타입필수값양식설명

code

String

true

인증 코드

newPassword

String

true

새로운 비밀번호

+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 102
+
+{
+  "status" : 200,
+  "code" : "200",
+  "msg" : "UPDATE SUCCESS",
+  "detailMsg" : "",
+  "data" : { }
+}
+
+
+
+
+

Response fields

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PathTypeDescription

status

Number

응답 상태 코드

code

String

응답 코드

msg

String

응답 메시지

detailMsg

String

상세 메시지

data

Object

데이터 없음

+
+
+
+

인증코드 요청

+
+

HTTP request

+
+
+
POST /auth/code HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Content-Length: 58
+Host: localhost:8080
+
+{
+  "email" : "alexj99@naver.com",
+  "isSignUp" : "true"
+}
+
+
+
+
+

Request body

+
+
+
{
+  "email" : "alexj99@naver.com",
+  "isSignUp" : "true"
+}
+
+
+
+
+

Request fields

+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
필드명타입필수값양식설명

email

String

true

이메일

isSignUp

String

true

회원가입 여부

+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 215
+
+{
+  "status" : 200,
+  "code" : "200",
+  "msg" : "SELECT SUCCESS",
+  "detailMsg" : "",
+  "data" : {
+    "grantType" : "Bearer",
+    "accessToken" : "accessToken",
+    "role" : "ROLE_AUTH_USER",
+    "userId" : 1
+  }
+}
+
+
+
+
+

Response fields

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PathTypeDescription

status

Number

응답 상태 코드

code

String

응답 코드

msg

String

응답 메시지

detailMsg

String

상세 메시지

data.grantType

String

토큰 타입

data.accessToken

String

액세스 토큰

data.role

String

사용자 권한

data.userId

Number

사용자 ID

+
+
+
+

인증코드 확인

+
+

HTTP request

+
+
+
PATCH /auth/verify HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+userId: 1
+Content-Length: 21
+Host: localhost:8080
+
+{
+  "code" : "1234"
+}
+
+
+
+
+

Request headers

+ ++++ + + + + + + + + + + + + +
NameDescription

userId

Bearer Token

+
+
+

Request body

+
+
+
{
+  "code" : "1234"
+}
+
+
+
+
+

Request fields

+ +++++++ + + + + + + + + + + + + + + + + + + +
필드명타입필수값양식설명

code

String

true

인증 코드

+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 102
+
+{
+  "status" : 200,
+  "code" : "200",
+  "msg" : "UPDATE SUCCESS",
+  "detailMsg" : "",
+  "data" : { }
+}
+
+
+
+
+

Response fields

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PathTypeDescription

status

Number

응답 상태 코드

code

String

응답 코드

msg

String

응답 메시지

detailMsg

String

상세 메시지

data

Object

데이터 없음

+
+
+
+
+
+

Trip

+
+
+

여행 등록

+
+

HTTP request

+
+
+
POST /core/trip/register HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+userId: 1
+Accept: application/json
+Content-Length: 83
+Host: localhost:8080
+
+{
+  "startDate" : "2024-04-11",
+  "endDate" : "2024-04-12",
+  "tripName" : "test"
+}
+
+
+
+
+

Request headers

+ ++++ + + + + + + + + + + + + +
NameDescription

userId

Bearer Token

+
+
+

Request body

+
+
+
{
+  "startDate" : "2024-04-11",
+  "endDate" : "2024-04-12",
+  "tripName" : "test"
+}
+
+
+
+
+

Request fields

+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
필드명타입필수값양식설명

tripName

String

true

여행 이름

startDate

String

true

yyyy-MM-dd

여행 시작 날짜

endDate

String

true

yyyy-MM-dd

여행 종료 날짜

+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 102
+
+{
+  "status" : 201,
+  "code" : "201",
+  "msg" : "INSERT SUCCESS",
+  "detailMsg" : "",
+  "data" : { }
+}
+
+
+
+
+

Response fields

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PathTypeDescription

status

Number

응답 상태 코드

code

String

응답 코드

msg

String

응답 메시지

detailMsg

String

상세 메시지

data

Object

데이터 없음

+
+
+
+

여행 목록 조회

+
+

HTTP request

+
+
+
GET /core/trip/all HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+userId: 1
+Accept: application/json
+Host: localhost:8080
+
+
+
+
+

Request headers

+ ++++ + + + + + + + + + + + + +
NameDescription

userId

Bearer Token

+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 628
+
+{
+  "status" : 200,
+  "code" : "200",
+  "msg" : "SELECT SUCCESS",
+  "detailMsg" : "",
+  "data" : {
+    "trips" : [ {
+      "id" : 1,
+      "email" : "test",
+      "startDate" : "2024-04-11",
+      "endDate" : "2024-04-12",
+      "analyzingCount" : 0,
+      "tripName" : "test"
+    }, {
+      "id" : 2,
+      "email" : "test",
+      "startDate" : "2024-04-11",
+      "endDate" : "2024-04-12",
+      "analyzingCount" : 1,
+      "tripName" : "test"
+    }, {
+      "id" : 3,
+      "email" : "test",
+      "startDate" : "2024-04-11",
+      "endDate" : "2024-04-12",
+      "analyzingCount" : 2,
+      "tripName" : "test"
+    } ]
+  }
+}
+
+
+
+
+

Response fields

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PathTypeDescription

status

Number

응답 상태 코드

code

String

응답 코드

msg

String

응답 메시지

detailMsg

String

상세 메시지

data.trips[].id

Number

여행 ID

data.trips[].email

String

유저 email

data.trips[].startDate

String

출발일

data.trips[].endDate

String

도착일

data.trips[].analyzingCount

Number

분석 중 파일 개수

data.trips[].tripName

String

여행 이름

+
+
+
+

여행 수정

+
+

HTTP request

+
+
+
PUT /core/trip HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+userId: 1
+Accept: application/json
+Content-Length: 99
+Host: localhost:8080
+
+{
+  "tripId" : 1,
+  "startDate" : "2024-04-11",
+  "endDate" : "2024-04-12",
+  "tripName" : "test"
+}
+
+
+
+
+

Request headers

+ ++++ + + + + + + + + + + + + +
NameDescription

userId

Bearer Token

+
+
+

Request body

+
+
+
{
+  "tripId" : 1,
+  "startDate" : "2024-04-11",
+  "endDate" : "2024-04-12",
+  "tripName" : "test"
+}
+
+
+
+
+

Request fields

+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
필드명타입필수값양식설명

tripId

Number

true

여행 ID

startDate

String

true

yyyy-MM-dd

출발일

endDate

String

true

yyyy-MM-dd

도착일

tripName

String

true

여행 이름

+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 102
+
+{
+  "status" : 200,
+  "code" : "200",
+  "msg" : "UPDATE SUCCESS",
+  "detailMsg" : "",
+  "data" : { }
+}
+
+
+
+
+

Response fields

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PathTypeDescription

status

Number

응답 상태 코드

code

String

응답 코드

msg

String

응답 메시지

detailMsg

String

상세 메시지

data

Object

데이터 없음

+
+
+
+

여행 삭제

+
+

HTTP request

+
+
+
DELETE /core/trip/1 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+userId: 1
+Accept: application/json
+Host: localhost:8080
+
+
+
+
+

Request headers

+ ++++ + + + + + + + + + + + + +
NameDescription

userId

Bearer Token

+
+
+

Path parameters

+ + ++++ + + + + + + + + + + + + +
Table 1. /core/trip/{tripId}
ParameterDescription

tripId

삭제할 여행 ID

+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 102
+
+{
+  "status" : 200,
+  "code" : "200",
+  "msg" : "DELETE SUCCESS",
+  "detailMsg" : "",
+  "data" : { }
+}
+
+
+
+
+

Response fields

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PathTypeDescription

status

Number

응답 상태 코드

code

String

응답 코드

msg

String

응답 메시지

detailMsg

String

상세 메시지

data

Object

데이터 없음

+
+
+
+
+
+ + + + + \ No newline at end of file