diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 9436ed8f..ae81427d 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -14,9 +14,8 @@ on: branches: [ "develop", "staging" ] permissions: - contents: write checks: write - id-token: write + pull-requests: write jobs: build: @@ -52,7 +51,7 @@ jobs: run: ./gradlew test - name: ๐Ÿ’ฌ ํ…Œ์ŠคํŠธ ๊ฒฐ๊ณผ๋ฅผ ์ฝ”๋ฉ˜ํŠธ๋กœ ๋“ฑ๋กํ•ฉ๋‹ˆ๋‹ค. - uses: EnricoMi/publish-unit-test-result-action@v1 + uses: EnricoMi/publish-unit-test-result-action@v2 if: always() with: files: '**/build/test-results/test/TEST-*.xml' diff --git a/.gitignore b/.gitignore index 97200f80..bf013630 100644 --- a/.gitignore +++ b/.gitignore @@ -47,4 +47,3 @@ firebase*.json ### monitoring ### monitoring/prometheus/volume monitoring/grafana -*.html \ No newline at end of file diff --git a/src/docs/asciidoc/index.adoc b/src/docs/asciidoc/index.adoc index 6e491286..d51d39c7 100644 --- a/src/docs/asciidoc/index.adoc +++ b/src/docs/asciidoc/index.adoc @@ -6,8 +6,6 @@ :toclevels: 3 :sectlinks: -ํ…Œ์ŠคํŠธํ…Œ์ŠคํŠธ - [[API-List]] == APIs diff --git a/src/main/resources/static/docs/add-friend.html b/src/main/resources/static/docs/add-friend.html new file mode 100644 index 00000000..c11c538f --- /dev/null +++ b/src/main/resources/static/docs/add-friend.html @@ -0,0 +1,501 @@ + + + + + + + +์นœ๊ตฌ ์ถ”๊ฐ€ํ•˜๊ธฐ + + + + + +
+
+

์นœ๊ตฌ ์ถ”๊ฐ€ํ•˜๊ธฐ

+
+
+

์š”์ฒญ

+
+
+
POST /api/v1/friend/1 HTTP/1.1
+Authorization: Bearer your-access-token
+
+
+
+
+

์š”์ฒญ ํŒŒ๋ผ๋ฏธํ„ฐ

+ + ++++ + + + + + + + + + + + + +
Table 1. /api/v1/friend/{targetId}
ParameterDescription

targetId

์นœ๊ตฌ ์‹ ์ฒญํ•  ์ƒ๋Œ€ ์œ ์ €์˜ ์•„์ด๋”” ๊ฐ’

+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "์นœ๊ตฌ ์ถ”๊ฐ€์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค."
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/apple.html b/src/main/resources/static/docs/apple.html new file mode 100644 index 00000000..3ff3b5c0 --- /dev/null +++ b/src/main/resources/static/docs/apple.html @@ -0,0 +1,549 @@ + + + + + + + +Apple ๊ตฌ๋… ๊ตฌ๋งค ๊ฒ€์ฆํ•˜๊ธฐ + + + + + +
+
+

Apple ๊ตฌ๋… ๊ตฌ๋งค ๊ฒ€์ฆํ•˜๊ธฐ

+
+
+

์š”์ฒญ

+
+
+
POST /api/v1/purchase/apple/verify/subscribe HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Authorization: Bearer your-access-token
+Content-Length: 68
+
+{
+  "transactionId" : "transactionId",
+  "productId" : "productId"
+}
+
+
+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "์ธ์•ฑ๊ฒฐ์ œ ๊ฒ€์ฆ์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค."
+}
+
+
+
+
+
+
+

Apple ์—ด๋žŒ๊ถŒ ๊ตฌ๋งค ๊ฒ€์ฆํ•˜๊ธฐ

+
+
+

์š”์ฒญ

+
+
+
POST /api/v1/purchase/apple/verify/ticket HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Authorization: Bearer your-access-token
+Content-Length: 68
+
+{
+  "transactionId" : "transactionId",
+  "productId" : "productId"
+}
+
+
+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "์ธ์•ฑ๊ฒฐ์ œ ๊ฒ€์ฆ์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค."
+}
+
+
+
+
+
+
+

Apple ํ™˜๋ถˆํ•˜๊ธฐ

+
+
+

์š”์ฒญ

+
+
+
DELETE /api/v1/purchase/apple/refund HTTP/1.1
+Authorization: Bearer your-access-token
+
+
+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "์ธ์•ฑ๊ฒฐ์ œ ๊ฒ€์ฆ์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค."
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/check-keyword.html b/src/main/resources/static/docs/check-keyword.html new file mode 100644 index 00000000..97598443 --- /dev/null +++ b/src/main/resources/static/docs/check-keyword.html @@ -0,0 +1,504 @@ + + + + + + + +ํˆฌํ‘œ ํ‚ค์›Œ๋“œ ํ™•์ธํ•˜๊ธฐ + + + + + +
+
+

ํˆฌํ‘œ ํ‚ค์›Œ๋“œ ํ™•์ธํ•˜๊ธฐ

+
+
+

์š”์ฒญ

+
+
+
PATCH /api/v1/vote/1/keyword HTTP/1.1
+Authorization: Bearer your-access-token
+
+
+
+
+

์š”์ฒญ ํŒŒ๋ผ๋ฏธํ„ฐ

+ + ++++ + + + + + + + + + + + + +
Table 1. /api/v1/vote/{voteId}/keyword
ParameterDescription

voteId

ํˆฌํ‘œ ์•„์ด๋”” ๊ฐ’

+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "ํ‚ค์›Œ๋“œ ํ™•์ธ์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค.",
+  "data" : {
+    "answer" : "test"
+  }
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/check-user-by-id.html b/src/main/resources/static/docs/check-user-by-id.html new file mode 100644 index 00000000..a29df723 --- /dev/null +++ b/src/main/resources/static/docs/check-user-by-id.html @@ -0,0 +1,488 @@ + + + + + + + +์œ ์ € ์ •๋ณด ์กฐํšŒํ•˜๊ธฐ + + + + + +
+
+

์œ ์ € ์ •๋ณด ์กฐํšŒํ•˜๊ธฐ

+
+
+

์š”์ฒญ

+
+
+
GET /api/v1/user/2 HTTP/1.1
+Authorization: Bearer your-access-token
+
+
+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "์œ ์ € ์กฐํšŒ์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค.",
+  "data" : {
+    "userId" : 2,
+    "name" : "test",
+    "profileImageUrl" : "profile",
+    "group" : "group",
+    "yelloId" : "yelloId",
+    "yelloCount" : 0,
+    "friendCount" : 0
+  }
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/check-user.html b/src/main/resources/static/docs/check-user.html new file mode 100644 index 00000000..4b0acfd6 --- /dev/null +++ b/src/main/resources/static/docs/check-user.html @@ -0,0 +1,489 @@ + + + + + + + +๋‚ด ์ •๋ณด ์กฐํšŒํ•˜๊ธฐ + + + + + +
+
+

๋‚ด ์ •๋ณด ์กฐํšŒํ•˜๊ธฐ

+
+
+

์š”์ฒญ

+
+
+
GET /api/v1/user HTTP/1.1
+Authorization: Bearer your-access-token
+
+
+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "์œ ์ € ์กฐํšŒ์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค.",
+  "data" : {
+    "userId" : 1,
+    "name" : "test",
+    "profileImageUrl" : "profile",
+    "group" : "group",
+    "yelloId" : "yelloId",
+    "yelloCount" : 0,
+    "friendCount" : 0,
+    "point" : 200
+  }
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/check-vote-available.html b/src/main/resources/static/docs/check-vote-available.html new file mode 100644 index 00000000..6f192f97 --- /dev/null +++ b/src/main/resources/static/docs/check-vote-available.html @@ -0,0 +1,484 @@ + + + + + + + +ํˆฌํ‘œ ๊ฐ€๋Šฅ ์—ฌ๋ถ€ ์กฐํšŒ + + + + + +
+
+

ํˆฌํ‘œ ๊ฐ€๋Šฅ ์—ฌ๋ถ€ ์กฐํšŒ

+
+
+

์š”์ฒญ

+
+
+
GET /api/v1/vote/available HTTP/1.1
+Authorization: Bearer your-access-token
+
+
+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "ํˆฌํ‘œ ์‹œ์ž‘ํ•˜๊ธฐ์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค.",
+  "data" : {
+    "isPossible" : false,
+    "point" : 200,
+    "createdAt" : "2023-08-25 20:51:31"
+  }
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/create-vote.html b/src/main/resources/static/docs/create-vote.html new file mode 100644 index 00000000..cb8ac7e9 --- /dev/null +++ b/src/main/resources/static/docs/create-vote.html @@ -0,0 +1,494 @@ + + + + + + + +ํˆฌํ‘œ ์ƒ์„ฑํ•˜๊ธฐ + + + + + +
+
+

ํˆฌํ‘œ ์ƒ์„ฑํ•˜๊ธฐ

+
+
+

์š”์ฒญ

+
+
+
POST /api/v1/vote HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Authorization: Bearer your-access-token
+Content-Length: 151
+
+{
+  "voteAnswerList" : [ {
+    "friendId" : 2,
+    "questionId" : 1,
+    "keywordName" : "ํ‚ค์›Œ๋“œ",
+    "colorIndex" : 0
+  } ],
+  "totalPoint" : 10
+}
+
+
+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 201,
+  "message" : "ํˆฌํ‘œ๋ฅผ ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค.",
+  "data" : {
+    "point" : 10
+  }
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/delete-friend.html b/src/main/resources/static/docs/delete-friend.html new file mode 100644 index 00000000..4707d7f8 --- /dev/null +++ b/src/main/resources/static/docs/delete-friend.html @@ -0,0 +1,501 @@ + + + + + + + +์นœ๊ตฌ ์‚ญ์ œํ•˜๊ธฐ + + + + + +
+
+

์นœ๊ตฌ ์‚ญ์ œํ•˜๊ธฐ

+
+
+

์š”์ฒญ

+
+
+
DELETE /api/v1/friend/1 HTTP/1.1
+Authorization: Bearer your-access-token
+
+
+
+
+

์š”์ฒญ ํŒŒ๋ผ๋ฏธํ„ฐ

+ + ++++ + + + + + + + + + + + + +
Table 1. /api/v1/friend/{targetId}
ParameterDescription

targetId

์‚ญ์ œํ•  ์ƒ๋Œ€ ์œ ์ €์˜ ์•„์ด๋”” ๊ฐ’

+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "์นœ๊ตฌ ์‚ญ์ œ์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค."
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/delete-user.html b/src/main/resources/static/docs/delete-user.html new file mode 100644 index 00000000..63e884e2 --- /dev/null +++ b/src/main/resources/static/docs/delete-user.html @@ -0,0 +1,479 @@ + + + + + + + +์œ ์ € ํƒˆํ‡ดํ•˜๊ธฐ + + + + + +
+
+

์œ ์ € ํƒˆํ‡ดํ•˜๊ธฐ

+
+
+

์š”์ฒญ

+
+
+
DELETE /api/v1/user HTTP/1.1
+Authorization: Bearer your-access-token
+
+
+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "์œ ์ € ํƒˆํ‡ด์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค."
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/device-token.html b/src/main/resources/static/docs/device-token.html new file mode 100644 index 00000000..424399f4 --- /dev/null +++ b/src/main/resources/static/docs/device-token.html @@ -0,0 +1,486 @@ + + + + + + + +๋””๋ฐ”์ด์Šค ํ† ํฐ ์ˆ˜์ •ํ•˜๊ธฐ + + + + + +
+
+

๋””๋ฐ”์ด์Šค ํ† ํฐ ์ˆ˜์ •ํ•˜๊ธฐ

+
+
+

์š”์ฒญ

+
+
+
PUT /api/v1/user/device HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Authorization: Bearer your-access-token
+Content-Length: 39
+
+{
+  "deviceToken" : "testDeviceToken"
+}
+
+
+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "deviceToken ์—…๋ฐ์ดํŠธ์— ์„ฑ๊ณตํ•˜์˜€์Šต๋‹ˆ๋‹ค",
+  "data" : { }
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/find-friend-votes.html b/src/main/resources/static/docs/find-friend-votes.html new file mode 100644 index 00000000..21065f52 --- /dev/null +++ b/src/main/resources/static/docs/find-friend-votes.html @@ -0,0 +1,517 @@ + + + + + + + +์นœ๊ตฌ ํˆฌํ‘œ ์ „์ฒด ์กฐํšŒ + + + + + +
+
+

์นœ๊ตฌ ํˆฌํ‘œ ์ „์ฒด ์กฐํšŒ

+
+
+

์š”์ฒญ

+
+
+
GET /api/v1/vote/friend?page=0 HTTP/1.1
+Authorization: Bearer your-access-token
+
+
+
+
+

์š”์ฒญ ํŒŒ๋ผ๋ฏธํ„ฐ

+ ++++ + + + + + + + + + + + + +
ParameterDescription

page

ํŽ˜์ด์ง€๋„ค์ด์…˜ ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ

+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "ํˆฌํ‘œ ์กฐํšŒ์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค.",
+  "data" : {
+    "totalCount" : 1,
+    "friendVotes" : [ {
+      "id" : 1,
+      "receiverName" : "name2",
+      "senderGender" : "MALE",
+      "vote" : {
+        "nameHead" : "๋‚˜๋Š”",
+        "nameFoot" : "์™€",
+        "keywordHead" : "๋ฉ‹์ง„",
+        "keyword" : "test",
+        "keywordFoot" : "์—์„œ ๋†€๊ณ ์‹ถ์–ด"
+      },
+      "isHintUsed" : false,
+      "createdAt" : "0์ดˆ ์ „"
+    } ]
+  }
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/find-friends.html b/src/main/resources/static/docs/find-friends.html new file mode 100644 index 00000000..9948df48 --- /dev/null +++ b/src/main/resources/static/docs/find-friends.html @@ -0,0 +1,512 @@ + + + + + + + +๋‚ด ์นœ๊ตฌ ์ „์ฒด ์กฐํšŒํ•˜๊ธฐ + + + + + +
+
+

๋‚ด ์นœ๊ตฌ ์ „์ฒด ์กฐํšŒํ•˜๊ธฐ

+
+
+

์š”์ฒญ

+
+
+
GET /api/v1/friend?page=0 HTTP/1.1
+Authorization: Bearer your-access-token
+
+
+
+
+

์š”์ฒญ ํŒŒ๋ผ๋ฏธํ„ฐ

+ ++++ + + + + + + + + + + + + +
ParameterDescription

page

ํŽ˜์ด์ง€๋„ค์ด์…˜ ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ

+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "์นœ๊ตฌ ์กฐํšŒ์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค.",
+  "data" : {
+    "totalCount" : 0,
+    "friends" : [ {
+      "userId" : 1,
+      "name" : "name1",
+      "profileImageUrl" : "test image",
+      "group" : "ํ…Œ์ŠคํŠธ ๋Œ€ํ•™๊ต 1 ํ…Œ์ŠคํŠธ ํ•™๊ณผ 1 20ํ•™๋ฒˆ",
+      "yelloId" : "yelloId1",
+      "yelloCount" : 0,
+      "friendCount" : 0
+    } ]
+  }
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/find-group-friends.html b/src/main/resources/static/docs/find-group-friends.html new file mode 100644 index 00000000..dd2e1b4e --- /dev/null +++ b/src/main/resources/static/docs/find-group-friends.html @@ -0,0 +1,509 @@ + + + + + + + +๊ทธ๋ฃน ์ถ”์ฒœ ์นœ๊ตฌ ์กฐํšŒํ•˜๊ธฐ + + + + + +
+
+

๊ทธ๋ฃน ์ถ”์ฒœ ์นœ๊ตฌ ์กฐํšŒํ•˜๊ธฐ

+
+
+

์š”์ฒญ

+
+
+
GET /api/v1/friend/recommend/school?page=0 HTTP/1.1
+Authorization: Bearer your-access-token
+
+
+
+
+

์š”์ฒญ ํŒŒ๋ผ๋ฏธํ„ฐ

+ ++++ + + + + + + + + + + + + +
ParameterDescription

page

ํŽ˜์ด์ง€๋„ค์ด์…˜ ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ

+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "์นœ๊ตฌ ์กฐํšŒ์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค.",
+  "data" : {
+    "totalCount" : 0,
+    "friends" : [ {
+      "id" : 1,
+      "name" : "name1",
+      "group" : "ํ…Œ์ŠคํŠธ ๋Œ€ํ•™๊ต 1 ํ…Œ์ŠคํŠธ ํ•™๊ณผ 1 20ํ•™๋ฒˆ",
+      "profileImage" : "test image"
+    } ]
+  }
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/find-kakao-friends.html b/src/main/resources/static/docs/find-kakao-friends.html new file mode 100644 index 00000000..fe65ed1e --- /dev/null +++ b/src/main/resources/static/docs/find-kakao-friends.html @@ -0,0 +1,506 @@ + + + + + + + +์นด์นด์˜ค ์ถ”์ฒœ ์นœ๊ตฌ ์กฐํšŒํ•˜๊ธฐ + + + + + +
+
+

์นด์นด์˜ค ์ถ”์ฒœ ์นœ๊ตฌ ์กฐํšŒํ•˜๊ธฐ

+
+
+

์š”์ฒญ

+
+
+
POST /api/v1/friend/recommend/kakao?page=0 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Authorization: Bearer your-access-token
+Content-Length: 41
+
+{
+  "friendKakaoId" : [ "testKakaoId" ]
+}
+
+
+
+
+

์š”์ฒญ ํŒŒ๋ผ๋ฏธํ„ฐ

+ ++++ + + + + + + + + + + + + +
ParameterDescription

page

ํŽ˜์ด์ง€๋„ค์ด์…˜ ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ

+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "์นœ๊ตฌ ์กฐํšŒ์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค."
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/find-onboarding-friends.html b/src/main/resources/static/docs/find-onboarding-friends.html new file mode 100644 index 00000000..3e3723d7 --- /dev/null +++ b/src/main/resources/static/docs/find-onboarding-friends.html @@ -0,0 +1,515 @@ + + + + + + + +๊ฐ€์ž…ํ•œ ์นœ๊ตฌ ๋ชฉ๋ก ๋ถˆ๋Ÿฌ์˜ค๊ธฐ + + + + + +
+
+

๊ฐ€์ž…ํ•œ ์นœ๊ตฌ ๋ชฉ๋ก ๋ถˆ๋Ÿฌ์˜ค๊ธฐ

+
+
+

์š”์ฒญ

+
+
+
POST /api/v1/auth/friend?page=0 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Content-Length: 43
+
+{
+  "friendKakaoId" : [ "friendKakaoId" ]
+}
+
+
+
+
+

์š”์ฒญ ํŒŒ๋ผ๋ฏธํ„ฐ

+ ++++ + + + + + + + + + + + + +
ParameterDescription

page

ํŽ˜์ด์ง€๋„ค์ด์…˜ ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ

+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "์ถ”์ฒœ ์นœ๊ตฌ ์กฐํšŒ์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค.",
+  "data" : {
+    "totalCount" : 0,
+    "friendList" : [ {
+      "group" : "KAKAO",
+      "id" : 1,
+      "name" : "name1",
+      "profileImage" : "test image",
+      "groupName" : "ํ…Œ์ŠคํŠธ ๋Œ€ํ•™๊ต 1 ํ…Œ์ŠคํŠธ ํ•™๊ณผ 1"
+    } ]
+  }
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/find-question.html b/src/main/resources/static/docs/find-question.html new file mode 100644 index 00000000..e41d8086 --- /dev/null +++ b/src/main/resources/static/docs/find-question.html @@ -0,0 +1,496 @@ + + + + + + + +ํˆฌํ‘œ ์งˆ๋ฌธ ์กฐํšŒํ•˜๊ธฐ + + + + + +
+
+

ํˆฌํ‘œ ์งˆ๋ฌธ ์กฐํšŒํ•˜๊ธฐ

+
+
+

์š”์ฒญ

+
+
+
GET /api/v1/vote/question HTTP/1.1
+Authorization: Bearer your-access-token
+
+
+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "ํˆฌํ‘œ ์งˆ๋ฌธ ๋ฆฌ์ŠคํŠธ ์กฐํšŒ์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค.",
+  "data" : [ {
+    "question" : {
+      "questionId" : 1,
+      "nameHead" : "๋‚˜๋Š”",
+      "nameFoot" : "์™€",
+      "keywordHead" : "๋ฉ‹์ง„",
+      "keywordFoot" : "์—์„œ ๋†€๊ณ ์‹ถ์–ด"
+    },
+    "friendList" : [ {
+      "friendId" : 2,
+      "friendName" : "name2",
+      "friendYelloId" : "yelloId2"
+    } ],
+    "keywordList" : [ "A", "B", "C", "D" ],
+    "questionPoint" : 10,
+    "subscribe" : "normal | active"
+  } ]
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/find-vote.html b/src/main/resources/static/docs/find-vote.html new file mode 100644 index 00000000..8e583c19 --- /dev/null +++ b/src/main/resources/static/docs/find-vote.html @@ -0,0 +1,518 @@ + + + + + + + +ํˆฌํ‘œ ์ƒ์„ธ ์กฐํšŒ + + + + + +
+
+

ํˆฌํ‘œ ์ƒ์„ธ ์กฐํšŒ

+
+
+

์š”์ฒญ

+
+
+
GET /api/v1/vote/1 HTTP/1.1
+Authorization: Bearer your-access-token
+
+
+
+
+

์š”์ฒญ ํŒŒ๋ผ๋ฏธํ„ฐ

+ + ++++ + + + + + + + + + + + + +
Table 1. /api/v1/vote/{voteId}
ParameterDescription

voteId

ํˆฌํ‘œ ์•„์ด๋”” ๊ฐ’

+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "ํˆฌํ‘œ ์กฐํšŒ์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค.",
+  "data" : {
+    "colorIndex" : 0,
+    "currentPoint" : 200,
+    "nameHint" : -1,
+    "isAnswerRevealed" : false,
+    "senderName" : "name1",
+    "senderGender" : "MALE",
+    "vote" : {
+      "nameHead" : "๋‚˜๋Š”",
+      "nameFoot" : "์™€",
+      "keywordHead" : "๋ฉ‹์ง„",
+      "keyword" : "test",
+      "keywordFoot" : "์—์„œ ๋†€๊ณ ์‹ถ์–ด"
+    },
+    "ticketCount" : 0,
+    "isSubscribe" : false
+  }
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/find-votes.html b/src/main/resources/static/docs/find-votes.html new file mode 100644 index 00000000..72e36426 --- /dev/null +++ b/src/main/resources/static/docs/find-votes.html @@ -0,0 +1,524 @@ + + + + + + + +๋‚ด ํˆฌํ‘œ ์ „์ฒด ์กฐํšŒ + + + + + +
+
+

๋‚ด ํˆฌํ‘œ ์ „์ฒด ์กฐํšŒ

+
+
+

์š”์ฒญ

+
+
+
GET /api/v1/vote?page=0 HTTP/1.1
+Authorization: Bearer your-access-token
+
+
+
+
+

์š”์ฒญ ํŒŒ๋ผ๋ฏธํ„ฐ

+ ++++ + + + + + + + + + + + + +
ParameterDescription

page

ํŽ˜์ด์ง€๋„ค์ด์…˜ ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ

+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "ํˆฌํ‘œ ์กฐํšŒ์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค.",
+  "data" : {
+    "totalCount" : 1,
+    "ticketCount" : 0,
+    "openCount" : 0,
+    "openKeywordCount" : 0,
+    "openNameCount" : 0,
+    "openFullNameCount" : 0,
+    "votes" : [ {
+      "id" : 1,
+      "senderGender" : "MALE",
+      "senderName" : "name1",
+      "nameHint" : -1,
+      "vote" : {
+        "nameHead" : "๋‚˜๋Š”",
+        "nameFoot" : "์™€",
+        "keywordHead" : "๋ฉ‹์ง„",
+        "keyword" : "test",
+        "keywordFoot" : "์—์„œ ๋†€๊ณ ์‹ถ์–ด"
+      },
+      "isHintUsed" : false,
+      "isRead" : false,
+      "createdAt" : "0์ดˆ ์ „"
+    } ]
+  }
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/get-unread-vote.html b/src/main/resources/static/docs/get-unread-vote.html new file mode 100644 index 00000000..332c20f5 --- /dev/null +++ b/src/main/resources/static/docs/get-unread-vote.html @@ -0,0 +1,482 @@ + + + + + + + +์ฝ์ง€ ์•Š์€ ์ชฝ์ง€ ๊ฐœ์ˆ˜ ์กฐํšŒ + + + + + +
+
+

์ฝ์ง€ ์•Š์€ ์ชฝ์ง€ ๊ฐœ์ˆ˜ ์กฐํšŒ

+
+
+

์š”์ฒญ

+
+
+
GET /api/v1/vote/count HTTP/1.1
+Authorization: Bearer your-access-token
+
+
+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "ํˆฌํ‘œ ์กฐํšŒ์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค.",
+  "data" : {
+    "totalCount" : 1
+  }
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/google.html b/src/main/resources/static/docs/google.html new file mode 100644 index 00000000..af531fa5 --- /dev/null +++ b/src/main/resources/static/docs/google.html @@ -0,0 +1,525 @@ + + + + + + + +Google ๊ตฌ๋… ๊ตฌ๋งค ๊ฒ€์ฆํ•˜๊ธฐ + + + + + +
+
+

Google ๊ตฌ๋… ๊ตฌ๋งค ๊ฒ€์ฆํ•˜๊ธฐ

+
+
+

์š”์ฒญ

+
+
+
POST /api/v1/purchase/google/verify/subscribe HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Authorization: Bearer your-access-token
+Content-Length: 239
+
+{
+  "orderId" : "orderId",
+  "packageName" : "packageName",
+  "productId" : "productId",
+  "purchaseTime" : 1,
+  "purchaseState" : 1,
+  "purchaseToken" : "purchaseToken",
+  "quantity" : 1,
+  "autoRenewing" : true,
+  "acknowledged" : true
+}
+
+
+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 201,
+  "message" : "๊ตฌ๊ธ€ ๊ตฌ๋… ๊ฒฐ์ œ ๊ฒ€์ฆ ๋ฐ ๋ฐ˜์˜์— ์„ฑ๊ณตํ•˜์˜€์Šต๋‹ˆ๋‹ค.",
+  "data" : {
+    "productId" : "productId",
+    "expiredAt" : "2023-08-25T20:51:30.274390"
+  }
+}
+
+
+
+
+
+
+

Google ์—ด๋žŒ๊ถŒ ๊ตฌ๋งค ๊ฒ€์ฆํ•˜๊ธฐ

+
+
+

์š”์ฒญ

+
+
+
GET /api/v1/friend/recommend/school?page=0 HTTP/1.1
+Authorization: Bearer your-access-token
+
+
+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "์ธ์•ฑ๊ฒฐ์ œ ๊ฒ€์ฆ์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค."
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/index.html b/src/main/resources/static/docs/index.html new file mode 100644 index 00000000..dad0d7ec --- /dev/null +++ b/src/main/resources/static/docs/index.html @@ -0,0 +1,614 @@ + + + + + + + +YELL:O API ๋ฌธ์„œ + + + + + + +
+
+

APIs

+
+
+

Auth API

+
+ +
+
+
+

User API

+
+ +
+
+
+

Vote API

+
+ +
+
+
+

Friend API

+
+ +
+
+
+

Purchase API

+
+ +
+
+
+

Pay API

+
+ +
+
+
+
+
+ + + + + + \ No newline at end of file diff --git a/src/main/resources/static/docs/login.html b/src/main/resources/static/docs/login.html new file mode 100644 index 00000000..c5f4577b --- /dev/null +++ b/src/main/resources/static/docs/login.html @@ -0,0 +1,491 @@ + + + + + + + +์†Œ์…œ ๋กœ๊ทธ์ธ + + + + + +
+
+

์†Œ์…œ ๋กœ๊ทธ์ธ

+
+
+

์š”์ฒญ

+
+
+
POST /api/v1/auth/oauth HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Content-Length: 91
+
+{
+  "accessToken" : "accessToken",
+  "social" : "social",
+  "deviceToken" : "deviceToken"
+}
+
+
+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 201,
+  "message" : "๋กœ๊ทธ์ธ์ด ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค.",
+  "data" : {
+    "isResigned" : false,
+    "accessToken" : "serviceAccessToken",
+    "refreshToken" : "serviceRefreshToken"
+  }
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/overview.html b/src/main/resources/static/docs/overview.html new file mode 100644 index 00000000..8b891673 --- /dev/null +++ b/src/main/resources/static/docs/overview.html @@ -0,0 +1,522 @@ + + + + + + + +Overview + + + + + +
+
+

Overview

+
+
+

Host

+ ++++ + + + + + + + + + + + + + + + + +
ํ™˜๊ฒฝHost

Development

BEํŒ€์—๊ฒŒ ๋ฌธ์˜

Production

BEํŒ€์—๊ฒŒ ๋ฌธ์˜

+
+
+

HTTP status codes

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
์ƒํƒœ ์ฝ”๋“œ์„ค๋ช…

200 OK

์„ฑ๊ณต

400 Bad Request

์ž˜๋ชป๋œ ์š”์ฒญ

401 Unauthorized

๋น„์ธ์ฆ ์ƒํƒœ

403 Forbidden

๊ถŒํ•œ ๊ฑฐ๋ถ€

404 Not Found

์กด์žฌํ•˜์ง€ ์•Š๋Š” ์š”์ฒญ ๋ฆฌ์†Œ์Šค

500 Internal Server Error

์„œ๋ฒ„ ์—๋Ÿฌ

+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/pay.html b/src/main/resources/static/docs/pay.html new file mode 100644 index 00000000..87595924 --- /dev/null +++ b/src/main/resources/static/docs/pay.html @@ -0,0 +1,485 @@ + + + + + + + +์นœ๊ตฌ ์ถ”๊ฐ€ํ•˜๊ธฐ + + + + + +
+
+

์นœ๊ตฌ ์ถ”๊ฐ€ํ•˜๊ธฐ

+
+
+

์š”์ฒญ

+
+
+
POST /api/v1/pay HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Authorization: Bearer your-access-token
+Content-Length: 17
+
+{
+  "index" : 1
+}
+
+
+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 201,
+  "message" : "์ด์šฉ๊ถŒ ๋ฒ„ํŠผ ํด๋ฆญ ํšŸ์ˆ˜๊ฐ€ ์ €์žฅ์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค."
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/purchase-check.html b/src/main/resources/static/docs/purchase-check.html new file mode 100644 index 00000000..400081bb --- /dev/null +++ b/src/main/resources/static/docs/purchase-check.html @@ -0,0 +1,484 @@ + + + + + + + +๊ตฌ๋… ์ƒํƒœ ๋ฐ ์—ด๋žŒ๊ถŒ ๊ฐœ์ˆ˜ ์กฐํšŒํ•˜๊ธฐ + + + + + +
+
+

๊ตฌ๋… ์ƒํƒœ ๋ฐ ์—ด๋žŒ๊ถŒ ๊ฐœ์ˆ˜ ์กฐํšŒํ•˜๊ธฐ

+
+
+

์š”์ฒญ

+
+
+
GET /api/v1/purchase HTTP/1.1
+Authorization: Bearer your-access-token
+
+
+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "์œ ์ € ๊ฒฐ์ œ ์ •๋ณด ์กฐํšŒ์— ์„ฑ๊ณตํ•˜์˜€์Šต๋‹ˆ๋‹ค",
+  "data" : {
+    "subscribeState" : "NORMAL",
+    "isSubscribe" : false,
+    "ticketCount" : 0
+  }
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/reissue-token.html b/src/main/resources/static/docs/reissue-token.html new file mode 100644 index 00000000..20957548 --- /dev/null +++ b/src/main/resources/static/docs/reissue-token.html @@ -0,0 +1,512 @@ + + + + + + + +ํ† ํฐ ์žฌ๋ฐœ๊ธ‰ + + + + + +
+
+

ํ† ํฐ ์žฌ๋ฐœ๊ธ‰

+
+
+

HTTP request

+
+
+
POST /api/v1/auth/token/issue HTTP/1.1
+X-ACCESS-AUTH: Bearer your-access-token
+X-REFRESH-AUTH: Bearer your-refresh-token
+
+
+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 201,
+  "message" : "ํ† ํฐ ์žฌ๋ฐœ๊ธ‰์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค.",
+  "data" : {
+    "accessToken" : "new accessToken",
+    "refreshToken" : "new refreshToken"
+  }
+}
+
+
+
+
+

์š”์ฒญ

+
+
+
POST /api/v1/auth/token/issue HTTP/1.1
+X-ACCESS-AUTH: Bearer your-access-token
+X-REFRESH-AUTH: Bearer your-refresh-token
+
+
+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 201,
+  "message" : "ํ† ํฐ ์žฌ๋ฐœ๊ธ‰์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค.",
+  "data" : {
+    "accessToken" : "new accessToken",
+    "refreshToken" : "new refreshToken"
+  }
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/reveal-full-name.html b/src/main/resources/static/docs/reveal-full-name.html new file mode 100644 index 00000000..0972a3b8 --- /dev/null +++ b/src/main/resources/static/docs/reveal-full-name.html @@ -0,0 +1,504 @@ + + + + + + + +ํˆฌํ‘œ ์ด๋ฆ„ ์ „์ฒด ์กฐํšŒ + + + + + +
+
+

ํˆฌํ‘œ ์ด๋ฆ„ ์ „์ฒด ์กฐํšŒ

+
+
+

์š”์ฒญ

+
+
+
PATCH /api/v1/vote/1/fullname HTTP/1.1
+Authorization: Bearer your-access-token
+
+
+
+
+

์š”์ฒญ ํŒŒ๋ผ๋ฏธํ„ฐ

+ + ++++ + + + + + + + + + + + + +
Table 1. /api/v1/vote/{voteId}/fullname
ParameterDescription

voteId

ํˆฌํ‘œ ์•„์ด๋”” ๊ฐ’

+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "์ „์ฒด ์ด๋ฆ„ ํ™•์ธ์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค.",
+  "data" : {
+    "name" : "name1"
+  }
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/reveal-name.html b/src/main/resources/static/docs/reveal-name.html new file mode 100644 index 00000000..d07b83d4 --- /dev/null +++ b/src/main/resources/static/docs/reveal-name.html @@ -0,0 +1,505 @@ + + + + + + + +ํˆฌํ‘œ ์ด๋ฆ„ ๋ถ€๋ถ„ ์กฐํšŒ + + + + + +
+
+

ํˆฌํ‘œ ์ด๋ฆ„ ๋ถ€๋ถ„ ์กฐํšŒ

+
+
+

์š”์ฒญ

+
+
+
PATCH /api/v1/vote/1/name HTTP/1.1
+Authorization: Bearer your-access-token
+
+
+
+
+

์š”์ฒญ ํŒŒ๋ผ๋ฏธํ„ฐ

+ + ++++ + + + + + + + + + + + + +
Table 1. /api/v1/vote/{voteId}/name
ParameterDescription

voteId

ํˆฌํ‘œ ์•„์ด๋”” ๊ฐ’

+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "์ด๋ฆ„ ์ดˆ์„ฑ ํ™•์ธ์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค.",
+  "data" : {
+    "name" : "n",
+    "nameIndex" : 0
+  }
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/search-department.html b/src/main/resources/static/docs/search-department.html new file mode 100644 index 00000000..5ae8c19f --- /dev/null +++ b/src/main/resources/static/docs/search-department.html @@ -0,0 +1,514 @@ + + + + + + + +๋Œ€ํ•™๊ต ํ•™๊ณผ ๊ฒ€์ƒ‰ํ•˜๊ธฐ + + + + + +
+
+

๋Œ€ํ•™๊ต ํ•™๊ณผ ๊ฒ€์ƒ‰ํ•˜๊ธฐ

+
+
+

์š”์ฒญ

+
+
+
GET /api/v1/auth/school/department?page=0&school=school+name+here&keyword=keyword+here HTTP/1.1
+
+
+
+
+

์š”์ฒญ ํŒŒ๋ผ๋ฏธํ„ฐ

+ ++++ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription

page

ํŽ˜์ด์ง€๋„ค์ด์…˜ ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ

school

ํ•™๊ต ์ด๋ฆ„

keyword

๊ฒ€์ƒ‰ํ•  ์ฟผ๋ฆฌ

+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "ํ•™๊ณผ ๊ฒ€์ƒ‰์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค.",
+  "data" : {
+    "totalCount" : 0,
+    "groupList" : [ {
+      "groupId" : 1,
+      "departmentName" : "ํ…Œ์ŠคํŠธ ํ•™๊ณผ 1"
+    } ]
+  }
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/search-friend.html b/src/main/resources/static/docs/search-friend.html new file mode 100644 index 00000000..faa74135 --- /dev/null +++ b/src/main/resources/static/docs/search-friend.html @@ -0,0 +1,515 @@ + + + + + + + +์นœ๊ตฌ ๊ฒ€์ƒ‰ํ•˜๊ธฐ + + + + + +
+
+

์นœ๊ตฌ ๊ฒ€์ƒ‰ํ•˜๊ธฐ

+
+
+

์š”์ฒญ

+
+
+
GET /api/v1/friend/search?page=0&keyword=keyword+here HTTP/1.1
+Authorization: Bearer your-access-token
+
+
+
+
+

์š”์ฒญ ํŒŒ๋ผ๋ฏธํ„ฐ

+ ++++ + + + + + + + + + + + + + + + + +
ParameterDescription

page

ํŽ˜์ด์ง€๋„ค์ด์…˜ ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ

keyword

๊ฒ€์ƒ‰ํ•  ์ฟผ๋ฆฌ

+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "์นœ๊ตฌ ๊ฒ€์ƒ‰ํ•˜๊ธฐ์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค.",
+  "data" : {
+    "totalCount" : 0,
+    "friendList" : [ {
+      "id" : 1,
+      "name" : "name1",
+      "group" : "ํ…Œ์ŠคํŠธ ๋Œ€ํ•™๊ต 1 ํ…Œ์ŠคํŠธ ํ•™๊ณผ 1 20ํ•™๋ฒˆ",
+      "profileImage" : "test image",
+      "yelloId" : "yelloId1",
+      "isFriend" : false
+    } ]
+  }
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/search-school.html b/src/main/resources/static/docs/search-school.html new file mode 100644 index 00000000..637a5812 --- /dev/null +++ b/src/main/resources/static/docs/search-school.html @@ -0,0 +1,507 @@ + + + + + + + +๋Œ€ํ•™๊ต ๊ฒ€์ƒ‰ํ•˜๊ธฐ + + + + + +
+
+

๋Œ€ํ•™๊ต ๊ฒ€์ƒ‰ํ•˜๊ธฐ

+
+
+

์š”์ฒญ

+
+
+
GET /api/v1/auth/school?page=0&keyword=keyword+here HTTP/1.1
+
+
+
+
+

์š”์ฒญ ํŒŒ๋ผ๋ฏธํ„ฐ

+ ++++ + + + + + + + + + + + + + + + + +
ParameterDescription

page

ํŽ˜์ด์ง€๋„ค์ด์…˜ ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ

keyword

๊ฒ€์ƒ‰ํ•  ์ฟผ๋ฆฌ

+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "ํ•™๊ต ๊ฒ€์ƒ‰์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค.",
+  "data" : {
+    "totalCount" : 0,
+    "groupNameList" : [ "groupName" ]
+  }
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/shuffle-friends.html b/src/main/resources/static/docs/shuffle-friends.html new file mode 100644 index 00000000..6dd6752a --- /dev/null +++ b/src/main/resources/static/docs/shuffle-friends.html @@ -0,0 +1,484 @@ + + + + + + + +์…”ํ”Œํ•œ ์นœ๊ตฌ ์กฐํšŒํ•˜๊ธฐ + + + + + +
+
+

์…”ํ”Œํ•œ ์นœ๊ตฌ ์กฐํšŒํ•˜๊ธฐ

+
+
+

์š”์ฒญ

+
+
+
GET /api/v1/friend/shuffle HTTP/1.1
+Authorization: Bearer your-access-token
+
+
+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "์นœ๊ตฌ ์…”ํ”Œ์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค.",
+  "data" : [ {
+    "friendId" : 2,
+    "friendName" : "name2",
+    "friendYelloId" : "yelloId2"
+  } ]
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/signup.html b/src/main/resources/static/docs/signup.html new file mode 100644 index 00000000..81c5ec72 --- /dev/null +++ b/src/main/resources/static/docs/signup.html @@ -0,0 +1,500 @@ + + + + + + + +ํšŒ์›๊ฐ€์ž… + + + + + +
+
+

ํšŒ์›๊ฐ€์ž…

+
+
+

์š”์ฒญ

+
+
+
POST /api/v1/auth/signup HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Content-Length: 307
+
+{
+  "social" : "KAKAO",
+  "uuid" : "uuid",
+  "deviceToken" : "deviceToken",
+  "email" : "email@emall.com",
+  "profileImage" : "profileImage",
+  "groupId" : 1,
+  "groupAdmissionYear" : 20,
+  "name" : "name",
+  "yelloId" : "yelloId",
+  "gender" : "MALE",
+  "friends" : [ 1 ],
+  "recommendId" : "recommendId"
+}
+
+
+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 201,
+  "message" : "ํšŒ์› ๊ฐ€์ž…์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค.",
+  "data" : {
+    "yelloId" : "yelloId",
+    "accessToken" : "serviceAccessToken",
+    "refreshToken" : "serviceRefreshToken"
+  }
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/sub-check.html b/src/main/resources/static/docs/sub-check.html new file mode 100644 index 00000000..6b02b3be --- /dev/null +++ b/src/main/resources/static/docs/sub-check.html @@ -0,0 +1,483 @@ + + + + + + + +๊ตฌ๋… ์—ฐ์žฅ ์œ ๋„ ํ•„์š” ์—ฌ๋ถ€ ํ™•์ธํ•˜๊ธฐ + + + + + +
+
+

๊ตฌ๋… ์—ฐ์žฅ ์œ ๋„ ํ•„์š” ์—ฌ๋ถ€ ํ™•์ธํ•˜๊ธฐ

+
+
+

์š”์ฒญ

+
+
+
GET /api/v1/purchase/subscribe HTTP/1.1
+Authorization: Bearer your-access-token
+
+
+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "์œ ์ € ๊ตฌ๋… ์—ฐ์žฅ ์œ ๋„ ํ•„์š” ์—ฌ๋ถ€ ํ™•์ธ ์กฐํšŒ์— ์„ฑ๊ณตํ•˜์˜€์Šต๋‹ˆ๋‹ค.",
+  "data" : {
+    "subscribe" : "NORMAL",
+    "isSubscribeNeeded" : false
+  }
+}
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/validate-yelloid.html b/src/main/resources/static/docs/validate-yelloid.html new file mode 100644 index 00000000..89a3508a --- /dev/null +++ b/src/main/resources/static/docs/validate-yelloid.html @@ -0,0 +1,500 @@ + + + + + + + +์˜๋กœ ์•„์ด๋”” ์ค‘๋ณต ํ™•์ธ + + + + + +
+
+

์˜๋กœ ์•„์ด๋”” ์ค‘๋ณต ํ™•์ธ

+
+
+

์š”์ฒญ

+
+
+
GET /api/v1/auth/valid?yelloId=yelloId+here HTTP/1.1
+
+
+
+
+

์š”์ฒญ ํŒŒ๋ผ๋ฏธํ„ฐ

+ ++++ + + + + + + + + + + + + +
ParameterDescription

yelloId

์ค‘๋ณต ์ฒดํฌํ•  yelloId

+
+
+

์‘๋‹ต

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "์˜๋กœ ์•„์ด๋”” ์ค‘๋ณต ์—ฌ๋ถ€ ์กฐํšŒ์— ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค.",
+  "data" : false
+}
+
+
+
+
+
+
+ + + \ No newline at end of file