From 793a65e8c3f2fddb1b897ce72b810846d3a2880a Mon Sep 17 00:00:00 2001 From: HyuckJuneHong Date: Mon, 25 Sep 2023 22:12:41 +0900 Subject: [PATCH] =?UTF-8?q?[JT-80]=20test:=20adoc=20=EC=9C=84=EC=B9=98=20?= =?UTF-8?q?=EB=B3=80=EA=B2=BD?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../src/{main => }/docs/asciidoc/index.adoc | 0 .../src/{main => }/docs/asciidoc/payment.adoc | 0 .../src/main/resources/static/docs/index.html | 633 ++++++++++++++++++ .../main/resources/static/docs/payment.html | 513 ++++++++++++++ 4 files changed, 1146 insertions(+) rename module-application/app-api/src/{main => }/docs/asciidoc/index.adoc (100%) rename module-application/app-api/src/{main => }/docs/asciidoc/payment.adoc (100%) create mode 100644 module-application/app-api/src/main/resources/static/docs/index.html create mode 100644 module-application/app-api/src/main/resources/static/docs/payment.html diff --git a/module-application/app-api/src/main/docs/asciidoc/index.adoc b/module-application/app-api/src/docs/asciidoc/index.adoc similarity index 100% rename from module-application/app-api/src/main/docs/asciidoc/index.adoc rename to module-application/app-api/src/docs/asciidoc/index.adoc diff --git a/module-application/app-api/src/main/docs/asciidoc/payment.adoc b/module-application/app-api/src/docs/asciidoc/payment.adoc similarity index 100% rename from module-application/app-api/src/main/docs/asciidoc/payment.adoc rename to module-application/app-api/src/docs/asciidoc/payment.adoc diff --git a/module-application/app-api/src/main/resources/static/docs/index.html b/module-application/app-api/src/main/resources/static/docs/index.html new file mode 100644 index 00000000..52d80e8f --- /dev/null +++ b/module-application/app-api/src/main/resources/static/docs/index.html @@ -0,0 +1,633 @@ + + + + + + + +JTOON API 문서 + + + + + + + +
+
+

1. 개요

+
+
+

이 API 문서는 'JTOON' 프로젝트의 산출물입니다.

+
+
+

1.1. API 서버 경로

+ +++++ + + + + + + + + + + + + + + + + + +

환경

DNS

비고

개발(dev)

운영(prod)

+
+ + + + + +
+ + +
+

해당 프로젝트 API 문서는 [특이사항]입니다.

+
+
+
+
+ + + + + +
+ + +
+

해당 프로젝트 API 문서는 [주의사항]입니다.

+
+
+
+
+
+

1.2. 응답형식

+
+

프로젝트는 다음과 같은 응답형식을 제공합니다.

+
+
+

1.2.1. 정상(2XX)

+ ++++ + + + + + + + + + + + + +
응답데이터가 없는 경우응답데이터가 있는 경우
+
+
{
+
+}
+
+
+
+
{
+  "name": "Hong-Dosan"
+}
+
+
+
+
+

1.2.2. 상태코드(HttpStatus)

+
+

응답시 다음과 같은 응답상태 헤더, 응답코드 및 응답메시지를 제공합니다.

+
+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
HttpStatus설명

OK(200)

정상 응답

CREATED(201)

새로운 리소스 생성

BAD_REQUEST(400)

요청값 누락, 잘못된 기입

UNAUTHORIZED(401)

비인증 요청

NOT_FOUND(404)

요청값 누락, 잘못된 기입, 비인가 접속 등

CONFLICT(409)

요청값 중복

INTERNAL_SERVER_ERROR(500)

알 수 없는 서버 에러가 발생했습니다. 관리자에게 문의하세요.

+
+

Unresolved directive in index.adoc - include::payment.adoc[]

+
+
+
+
+
+
+ + + + + \ No newline at end of file diff --git a/module-application/app-api/src/main/resources/static/docs/payment.html b/module-application/app-api/src/main/resources/static/docs/payment.html new file mode 100644 index 00000000..e443e20d --- /dev/null +++ b/module-application/app-api/src/main/resources/static/docs/payment.html @@ -0,0 +1,513 @@ + + + + + + + +결제(Payment) + + + + + +
+
+

결제(Payment)

+
+
+
+
결제에 대한 검증/등록/조회/취소 기능을 제공합니다.
+
+
+
+

결제 검증 및 생성

+
+
+
1) 실제 결제된 금액(IamportClient에서 제공)과 금액(amount)를 비교해 검증합니다.
+2) 실제 서버에서 알고 있는 금액(CookieItem.amount)과 금액(amount)를 비교해 검증합니다.
+3) 포트원 결제 고유번호(impUid)와 가맹점 주문번호(merchantUid)가 중복 됐는 지 검증합니다.
+4) 검증 후 결제 정보 생성 여부를 결정합니다.
+
+
+

요청

+
+
+
POST /payments/validation HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Content-Length: 231
+Host: localhost:8080
+
+{
+  "impUid" : "impUid123",
+  "merchantUid" : "merchant123",
+  "payMethod" : "card",
+  "itemName" : "쿠키 10개",
+  "amount" : 1000,
+  "buyerEmail" : "test@naver.com",
+  "buyerName" : "홍도산",
+  "buyerPhone" : "01012311231"
+}
+
+
+

응답

+
+
+
HTTP/1.1 500 Internal Server Error
+Vary: Origin
+Vary: Access-Control-Request-Method
+Vary: Access-Control-Request-Headers
+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: 22
+
+{
+  "message" : null
+}
+
+
+
+
+
+
+ + + \ No newline at end of file