From d1a83e7530a474a2493dc5eb5c0249ad5985009f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E1=84=8B=E1=85=B5=E1=84=80=E1=85=A5=E1=86=AB=E1=84=8E?= =?UTF-8?q?=E1=85=A1=E1=86=BC?= <92219795+this-is-spear@users.noreply.github.com> Date: Thu, 4 Jan 2024 00:55:10 +0900 Subject: [PATCH] =?UTF-8?q?api=20=EB=AC=B8=EC=84=9C=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 | 989 ++++++++++++++++++++++ 1 file changed, 989 insertions(+) create mode 100644 src/main/resources/static/docs/index.html diff --git a/src/main/resources/static/docs/index.html b/src/main/resources/static/docs/index.html new file mode 100644 index 0000000..b3f88fd --- /dev/null +++ b/src/main/resources/static/docs/index.html @@ -0,0 +1,989 @@ + + + + + + + +Money Transfer Service + + + + + + +
+
+

Banking API

+
+
+

기록 조회

+
+

HTTP request

+
+
+
GET /account/850-7677-112404/history?_csrf=afxIBwiY4fQKlVHUwpH02j8DrE40vnfzI7-nR2_Ci71yaBm5W814Pzut08wnoTDt87zA6FwzgS8C3U7eGoaTdl_xs4hLXija HTTP/1.1
+Host: 127.0.0.1:8080
+
+
+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+X-Content-Type-Options: nosniff
+X-XSS-Protection: 0
+Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+Pragma: no-cache
+Expires: 0
+X-Frame-Options: DENY
+Content-Length: 1389
+
+{
+  "balance" : {
+    "amount" : 20000
+  },
+  "historyResponses" : [ {
+    "historyType" : "DEPOSIT",
+    "money" : {
+      "amount" : 20000
+    },
+    "fromAccountNumber" : {
+      "number" : "850-7677-112404"
+    },
+    "toAccountNumber" : {
+      "number" : "742-3975-124600"
+    },
+    "recordDate" : "2022-02-13T12:10:00"
+  }, {
+    "historyType" : "WITHDRAW",
+    "money" : {
+      "amount" : 5000
+    },
+    "fromAccountNumber" : {
+      "number" : "850-7677-112404"
+    },
+    "toAccountNumber" : {
+      "number" : "042-3545-569995"
+    },
+    "recordDate" : "2022-02-03T04:10:00"
+  }, {
+    "historyType" : "WITHDRAW",
+    "money" : {
+      "amount" : 10000
+    },
+    "fromAccountNumber" : {
+      "number" : "850-7677-112404"
+    },
+    "toAccountNumber" : {
+      "number" : "747-0165-603311"
+    },
+    "recordDate" : "2022-02-01T21:10:00"
+  }, {
+    "historyType" : "DEPOSIT",
+    "money" : {
+      "amount" : 100000
+    },
+    "fromAccountNumber" : {
+      "number" : "850-7677-112404"
+    },
+    "toAccountNumber" : {
+      "number" : "850-7454-030406"
+    },
+    "recordDate" : "2022-01-21T20:10:00"
+  }, {
+    "historyType" : "WITHDRAW",
+    "money" : {
+      "amount" : 15000
+    },
+    "fromAccountNumber" : {
+      "number" : "850-7677-112404"
+    },
+    "toAccountNumber" : {
+      "number" : "624-9020-659277"
+    },
+    "recordDate" : "2022-01-10T08:10:00"
+  } ]
+}
+
+
+
+
+
+

금액 입금

+
+

HTTP request

+
+
+
POST /account/850-7677-112404/deposit?_csrf=MPbZP4AUEbRN_e7Y9qAWI-wQdJTOGMoB0VuGAILUkIggcUFABcfsCOUnII1gxdi9xY0iF911Wfb9IKss5j61NLLmorEVQiAm HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Idempotency-Key: ee39c0d9-f947-4077-a3b2-720b5cce8346
+Content-Length: 22
+Host: 127.0.0.1:8080
+
+{
+  "amount" : 20000
+}
+
+
+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+X-Content-Type-Options: nosniff
+X-XSS-Protection: 0
+Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+Pragma: no-cache
+Expires: 0
+X-Frame-Options: DENY
+
+
+
+
+
+

금액 출금

+
+

HTTP request

+
+
+
POST /account/850-7677-112404/withdraw?_csrf=OeV8KmWmT_UqqoA4AZ5KcgjxrlcI6zAUfO2vlmzMqc8-eMkaAIEYEgeRKcUHmOQAZbN-Sz_DgzU_31Y5ToibpVWtzfkNT6h4 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Idempotency-Key: c75ff696-b02a-457b-bacb-6f782a077404
+Content-Length: 22
+Host: 127.0.0.1:8080
+
+{
+  "amount" : 20000
+}
+
+
+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+X-Content-Type-Options: nosniff
+X-XSS-Protection: 0
+Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+Pragma: no-cache
+Expires: 0
+X-Frame-Options: DENY
+
+
+
+
+
+

계좌 이체

+
+

HTTP request

+
+
+
POST /account/850-7677-112404/transfer?_csrf=pKIDtjegX032qiY_tufMW0jCaddIINgMwE3apygOiGXJ5j11xZNgh1bDaCnbnx8L0Mr4aimjRLYtErkhoS7rlBBr6Vb41VhN HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Idempotency-Key: 8893c4cc-92f1-48f8-a61a-5bdcbc04ded5
+Content-Length: 84
+Host: 127.0.0.1:8080
+
+{
+  "toAccountNumber" : "850-7677-112404",
+  "amount" : {
+    "amount" : 20000
+  }
+}
+
+
+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+X-Content-Type-Options: nosniff
+X-XSS-Protection: 0
+Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+Pragma: no-cache
+Expires: 0
+X-Frame-Options: DENY
+
+
+
+
+
+

이체 대상 확인

+
+

HTTP request

+
+
+
GET /account/850-7677-112404/transfer/targets HTTP/1.1
+Host: 127.0.0.1:8080
+
+
+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+X-Content-Type-Options: nosniff
+X-XSS-Protection: 0
+Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+Pragma: no-cache
+Expires: 0
+X-Frame-Options: DENY
+Content-Length: 407
+
+{
+  "targets" : [ {
+    "name" : "name1",
+    "email" : "member1@email.com",
+    "accountNumber" : {
+      "number" : "464-0302-900631"
+    }
+  }, {
+    "name" : "name2",
+    "email" : "member2@email.com",
+    "accountNumber" : {
+      "number" : "758-4846-349518"
+    }
+  }, {
+    "name" : "name3",
+    "email" : "member3@email.com",
+    "accountNumber" : {
+      "number" : "326-9571-076141"
+    }
+  } ]
+}
+
+
+
+
+
+
+
+

Member API

+
+
+

회원가입

+
+

HTTP request

+
+
+
POST /members/register?_csrf=34sve9Temr7aMJhUb4f1Qo0jvovlJtyHrl7vkIIMeArL9rRCvbpJTLLtrI73AKFsCqrBe7QRk7PSE-Sqy2yMpLdtHGjzkNV7 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Content-Length: 82
+Host: 127.0.0.1:8080
+
+{
+  "password" : "password",
+  "name" : "tis",
+  "email" : "rjsckdd12@gmail.com"
+}
+
+
+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+X-Content-Type-Options: nosniff
+X-XSS-Protection: 0
+Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+Pragma: no-cache
+Expires: 0
+X-Frame-Options: DENY
+
+
+
+
+
+

사용자 조회

+
+

HTTP request

+
+
+
GET /members/me?_csrf=UnsqoFc6E4ihDSmx3pI8-hibQkTM1xsghACkwoSvy1eIttfHY0pOxG8LdbqMPhnQ7r8Iziyob33-5HoNszCToLeerW-41-Sh HTTP/1.1
+Host: 127.0.0.1:8080
+
+
+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+X-Content-Type-Options: nosniff
+X-XSS-Protection: 0
+Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+Pragma: no-cache
+Expires: 0
+X-Frame-Options: DENY
+Content-Length: 45
+
+{
+  "id" : 2,
+  "name" : "member@email.com"
+}
+
+
+
+
+
+
+
+

Social API

+
+
+

친구 신청

+
+

HTTP request

+
+
+
POST /members/friends/2 HTTP/1.1
+Content-Type: application/x-www-form-urlencoded
+Host: 127.0.0.1:8080
+Content-Length: 102
+
+_csrf=pvbSQimhJP2LCIPYEL-Dc6CpLhG0Q8ELUyEpJsbY9NoZSHw6ksDqJx6VEp6mO-LvI5K3EJDIAymEIvEmMkQfQ6fhx-t4LBkK
+
+
+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+X-Content-Type-Options: nosniff
+X-XSS-Protection: 0
+Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+Pragma: no-cache
+Expires: 0
+X-Frame-Options: DENY
+
+
+
+
+
+

친구 신청 승인

+
+

HTTP request

+
+
+
POST /members/friends/1/approval HTTP/1.1
+Content-Type: application/x-www-form-urlencoded
+Host: 127.0.0.1:8080
+Content-Length: 102
+
+_csrf=9Pd-A3hTIMERbGsS6gfBRve8jfR8qhRZ9Kpr5LpYjCqQRAW7w8dPYUFlEfI8XA503Sr1IpPYoM1Fnix0l8xe14hg7h2oJ2OL
+
+
+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+X-Content-Type-Options: nosniff
+X-XSS-Protection: 0
+Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+Pragma: no-cache
+Expires: 0
+X-Frame-Options: DENY
+
+
+
+
+
+

친구 신청 거절

+
+

HTTP request

+
+
+
POST /members/friends/1/rejected HTTP/1.1
+Content-Type: application/x-www-form-urlencoded
+Host: 127.0.0.1:8080
+Content-Length: 102
+
+_csrf=iLrlEA-fxuoPAtNN2JvdnZvS502L33FdCq0eSpbdGqqTHcZxvYzUJm38_okiYLZ8vrbpr6KzynXuvhNwaZkte_Pre5OiLaJF
+
+
+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+X-Content-Type-Options: nosniff
+X-XSS-Protection: 0
+Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+Pragma: no-cache
+Expires: 0
+X-Frame-Options: DENY
+
+
+
+
+
+

친구 목록 조회

+
+

HTTP request

+
+
+
GET /members/friends?_csrf=AweIcwrK3hnNO8M3HCMvRk91n6-RBC9rl6hvmtK1BbKlkoZkMTLpRDv57i7gWfFWKA4bcX9Ess2oMRxG85Fb-eGMNIPDpONV HTTP/1.1
+Host: 127.0.0.1:8080
+
+
+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+X-Content-Type-Options: nosniff
+X-XSS-Protection: 0
+Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+Pragma: no-cache
+Expires: 0
+X-Frame-Options: DENY
+Content-Length: 192
+
+{
+  "friendResponses" : [ {
+    "userId" : 4,
+    "name" : "name",
+    "email" : "member@email.com"
+  }, {
+    "userId" : 11,
+    "name" : "name113",
+    "email" : "member14@email.com"
+  } ]
+}
+
+
+
+
+
+

친구 신청 목록 조회

+
+

HTTP request

+
+
+
GET /members/friends/requests?_csrf=TerAKsV_WjqAgII27M5-Jh2_GbDDFpbI8OJWoE8YmSHogoe7eN_2GfQbb1itsLMH1eNKFiuGNImiLqTlw4Zlkywv-hDYtuaL HTTP/1.1
+Host: 127.0.0.1:8080
+
+
+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+X-Content-Type-Options: nosniff
+X-XSS-Protection: 0
+Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+Pragma: no-cache
+Expires: 0
+X-Frame-Options: DENY
+Content-Length: 251
+
+{
+  "askedFriendResponses" : [ {
+    "requestId" : 2,
+    "fromUserId" : 13,
+    "name" : "name",
+    "email" : "member@gmail.com"
+  }, {
+    "requestId" : 22,
+    "fromUserId" : 133,
+    "name" : "name123",
+    "email" : "member123@email.com"
+  } ]
+}
+
+
+
+
+
+
+
+ + + + + + \ No newline at end of file