Skip to content

Commit

Permalink
Merge pull request #74 from kookmin-sw/backend/develop/v3
Browse files Browse the repository at this point in the history
✨ adoc파일 및 /build/이하 디렉토리 추가
  • Loading branch information
J-Yong99 authored Apr 11, 2024
2 parents 360f64d + 087da95 commit 3878940
Show file tree
Hide file tree
Showing 164 changed files with 13,913 additions and 0 deletions.

Large diffs are not rendered by default.

1,047 changes: 1,047 additions & 0 deletions backend/moment/moment-server/core/build/docs/asciidoc/Auth.html

Large diffs are not rendered by default.

1,581 changes: 1,581 additions & 0 deletions backend/moment/moment-server/core/build/docs/asciidoc/CardView.html

Large diffs are not rendered by default.

1,053 changes: 1,053 additions & 0 deletions backend/moment/moment-server/core/build/docs/asciidoc/Trip.html

Large diffs are not rendered by default.

3,057 changes: 3,057 additions & 0 deletions backend/moment/moment-server/core/build/docs/asciidoc/index.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[source,bash]
----
$ curl 'http://localhost:8080/core/alreadyBookedDate/all' -i -X GET \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'userId: 1'
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
[source,http,options="nowrap"]
----
GET /core/alreadyBookedDate/all HTTP/1.1
Content-Type: application/json;charset=UTF-8
userId: 1
Host: localhost:8080
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
[source,http,options="nowrap"]
----
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"
} ]
}
}
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[source,bash]
----
$ http GET 'http://localhost:8080/core/alreadyBookedDate/all' \
'Content-Type:application/json;charset=UTF-8' \
'userId:1'
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[source,json,options="nowrap"]
----
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
|===
|Name|Description

|`+userId+`
|Bearer Token

|===
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
[source,json,options="nowrap"]
----
{
"status" : 200,
"code" : "200",
"msg" : "SELECT SUCCESS",
"detailMsg" : "",
"data" : {
"cardViews" : [ {
"bookedDate" : "2024-04-11"
}, {
"bookedDate" : "2023-10-10"
} ]
}
}
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
|===
|Path|Type|Description

|`+status+`
|`+Number+`
|응답 상태 코드

|`+code+`
|`+String+`
|응답 코드

|`+msg+`
|`+String+`
|응답 메시지

|`+detailMsg+`
|`+String+`
|상세 메시지

|`+data.cardViews[].bookedDate+`
|`+String+`
|예약된 날짜 목록

|===
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[source,bash]
----
$ curl 'http://localhost:8080/auth/password' -i -X PATCH \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'userId: 1' \
-d '{
"code" : "1234",
"newPassword" : "12345"
}'
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
[source,http,options="nowrap"]
----
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"
}
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[source,http,options="nowrap"]
----
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 102
{
"status" : 200,
"code" : "200",
"msg" : "UPDATE SUCCESS",
"detailMsg" : "",
"data" : { }
}
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[source,bash]
----
$ echo '{
"code" : "1234",
"newPassword" : "12345"
}' | http PATCH 'http://localhost:8080/auth/password' \
'Content-Type:application/json;charset=UTF-8' \
'userId:1'
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[source,json,options="nowrap"]
----
{
"code" : "1234",
"newPassword" : "12345"
}
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
|===
|필드명|타입|필수값|양식|설명

|`+code+`
|`+String+`
|true
|
|인증 코드
|`+newPassword+`
|`+String+`
|true
|
|새로운 비밀번호
|===
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
|===
|Name|Description

|`+userId+`
|Bearer Token

|===
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[source,json,options="nowrap"]
----
{
"status" : 200,
"code" : "200",
"msg" : "UPDATE SUCCESS",
"detailMsg" : "",
"data" : { }
}
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
|===
|Path|Type|Description

|`+status+`
|`+Number+`
|응답 상태 코드

|`+code+`
|`+String+`
|응답 코드

|`+msg+`
|`+String+`
|응답 메시지

|`+detailMsg+`
|`+String+`
|상세 메시지

|`+data+`
|`+Object+`
|데이터 없음

|===
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[source,bash]
----
$ curl 'http://localhost:8080/auth/login' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
"email" : "[email protected]",
"password" : "1234"
}'
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
[source,http,options="nowrap"]
----
POST /auth/login HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 58
Host: localhost:8080
{
"email" : "[email protected]",
"password" : "1234"
}
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
[source,http,options="nowrap"]
----
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"
}
}
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
[source,bash]
----
$ echo '{
"email" : "[email protected]",
"password" : "1234"
}' | http POST 'http://localhost:8080/auth/login' \
'Content-Type:application/json;charset=UTF-8'
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[source,json,options="nowrap"]
----
{
"email" : "[email protected]",
"password" : "1234"
}
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
|===
|필드명|타입|필수값|양식|설명

|`+email+`
|`+String+`
|true
|
|이메일
|`+password+`
|`+String+`
|true
|
|비밀번호
|===
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
[source,json,options="nowrap"]
----
{
"status" : 200,
"code" : "200",
"msg" : "SELECT SUCCESS",
"detailMsg" : "",
"data" : {
"grantType" : "Bearer",
"accessToken" : "accessToken",
"refreshToken" : "refresh",
"role" : "ROLE_AUTH_USER"
}
}
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
|===
|Path|Type|Description

|`+status+`
|`+Number+`
|응답 상태 코드

|`+code+`
|`+String+`
|응답 코드

|`+msg+`
|`+String+`
|응답 메시지

|`+detailMsg+`
|`+String+`
|상세 메시지

|`+data.grantType+`
|`+String+`
|토큰 타입

|`+data.accessToken+`
|`+String+`
|액세스 토큰

|`+data.refreshToken+`
|`+String+`
|리프레시 토큰

|`+data.role+`
|`+String+`
|사용자 권한

|===
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[source,bash]
----
$ curl 'http://localhost:8080/auth/code' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
"email" : "[email protected]",
"isSignUp" : "true"
}'
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
[source,http,options="nowrap"]
----
POST /auth/code HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 58
Host: localhost:8080
{
"email" : "[email protected]",
"isSignUp" : "true"
}
----
Loading

0 comments on commit 3878940

Please sign in to comment.