From 6c0e00ab349823bff76d36492bcd4be5462dff98 Mon Sep 17 00:00:00 2001 From: bum12ark Date: Mon, 7 Feb 2022 20:11:56 +0900 Subject: [PATCH] =?UTF-8?q?docs(order,=20store,=20user):=20=EC=A0=90?= =?UTF-8?q?=EC=A3=BC=20=EC=84=9C=EB=B9=84=EC=8A=A4=20=EA=B0=80=20=EC=A3=BC?= =?UTF-8?q?=EB=AC=B8=20=ED=8E=98=EC=9D=B4=EC=A7=80=20=EB=A1=9C=EC=A7=81?= =?UTF-8?q?=EC=97=90=20=ED=95=B4=EB=8B=B9=ED=95=98=EB=8A=94=20api=20?= =?UTF-8?q?=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 - 점주 서비스 (주문 페이지) 로직에 해당하는 각 서비스의 api 문서가 추가되었습니다. --- .../main/resources/static/docs/api-docs.html | 836 ++++++++++++++++++ store-service/src/docs/asciidoc/api-docs.adoc | 71 ++ .../main/resources/static/docs/api-docs.html | 778 ++++++++++++++++ .../main/resources/static/docs/api-docs.html | 772 ++++++++++++++++ 4 files changed, 2457 insertions(+) create mode 100644 order-service/src/main/resources/static/docs/api-docs.html create mode 100644 store-service/src/docs/asciidoc/api-docs.adoc create mode 100644 store-service/src/main/resources/static/docs/api-docs.html create mode 100644 user-service/src/main/resources/static/docs/api-docs.html diff --git a/order-service/src/main/resources/static/docs/api-docs.html b/order-service/src/main/resources/static/docs/api-docs.html new file mode 100644 index 0000000..148f1af --- /dev/null +++ b/order-service/src/main/resources/static/docs/api-docs.html @@ -0,0 +1,836 @@ + + + + + + + +개요 + + + + + + +
+
+

HTTP 동사

+
+
+

본 REST API에서 사용하는 HTTP 동사(verbs)는 가능한한 표준 HTTP와 REST 규약을 따릅니다.

+
+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
동사용례

GET

리소스를 가져올 때 사용

POST

새 리소스를 만들 때 사용

PUT

기존 리소스를 수정할 때 사용

PATCH

기존 리소스의 일부를 수정할 때 사용

DELETE

기존 리소스를 삭제할 떄 사용

+
+
+
+

HTTP 상태 코드

+
+
+

본 REST API에서 사용하는 HTTP 상태 코드는 가능한 표준 HTTP와 REST 규약을 따릅니다.

+
+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
상태 코드용례

200 OK

요청을 성공적으로 처리함

201 Created

새 리소스를 성공적으로 생성함. 응답의 Location 헤더에 해당 리소스의 URI가 담겨있다.

204 No Content

기존 리소스를 성공적으로 수정함.

400 Bad Request

잘못된 요청을 보낸 경우. 응답 본문에 더 오류에 대한 정보가 담겨있다.

404 Not Found

요청한 리소스가 없음.

409 Conflict

클라이언트의 요청이 서버의 상태와 충돌이 발생한 경우.

+
+
+
+

snippets 작성 컨벤션

+
+
+

domain-httpRequestCode-etc

+
+
+
+
+

주문

+
+
+

점주 서비스 - 주문 페이지

+
+
    +
  • +

    페이지 offset : 6

    +
    • +
+
+
+

Curl request

+
+
+
$ curl 'http://127.0.0.1:8001/orderMain?orderDate=2022-02-03&lastOrderId=7' -i -X GET
+
+
+
+
+

HTTP request

+
+
+
GET /orderMain?orderDate=2022-02-03&lastOrderId=7 HTTP/1.1
+Host: 127.0.0.1:8001
+
+
+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 769
+
+{
+  "code" : "SUCCESS",
+  "message" : "",
+  "data" : [ {
+    "orderId" : 1,
+    "userId" : 1,
+    "userName" : "닉네임",
+    "orderItemResponses" : [ {
+      "orderItemId" : 100,
+      "itemId" : 100,
+      "itemName" : "아이템1"
+    }, {
+      "orderItemId" : 101,
+      "itemId" : 101,
+      "itemName" : "아이템2"
+    } ],
+    "orderStatus" : "PLACED",
+    "orderTime" : "2022-02-03 14:00:00"
+  }, {
+    "orderId" : 2,
+    "userId" : 1,
+    "userName" : "닉네임",
+    "orderItemResponses" : [ {
+      "orderItemId" : 102,
+      "itemId" : 102,
+      "itemName" : "아이템3"
+    }, {
+      "orderItemId" : 103,
+      "itemId" : 103,
+      "itemName" : "아이템2"
+    } ],
+    "orderStatus" : "CANCELED",
+    "orderTime" : "2022-02-03 15:00:00"
+  } ]
+}
+
+
+
+
+

Request parameters

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

orderDate

주문 날짜 YYYY-MM-DD

lastOrderId

페이지의 마지막 주문 고유 번호

+
+
+

Response fields

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

code

String

결과 코드 SUCCESS/ERROR

message

String

메시지

data[*].orderId

Number

주문 고유 번호

data[*].userId

Number

고객 고유 번호

data[*].userName

String

고객 이름

data[*].orderItemResponses[*].orderItemId

Number

장바구니 고유번호

data[*].orderItemResponses[*].itemId

Number

상품 고유번호

data[*].orderItemResponses[*].itemName

String

상품 이름

data[*].orderStatus

String

주문 상태

data[*].orderTime

String

주문 시간

+
+
+
+

점주 서비스 - 주문 페이지 (잘못된 파라미터 형식)

+
+

Curl request

+
+
+
$ curl 'http://127.0.0.1:8001/orderMain?orderDate=20220203&lastOrderId=7' -i -X GET
+
+
+
+
+

HTTP request

+
+
+
GET /orderMain?orderDate=20220203&lastOrderId=7 HTTP/1.1
+Host: 127.0.0.1:8001
+
+
+
+
+

HTTP response

+
+
+
HTTP/1.1 400 Bad Request
+Content-Type: application/json
+Content-Length: 160
+
+{
+  "code" : "ERROR",
+  "message" : "[orderDate](은)는 YYYY-MM-DD 형식에 맞게 작성되지 않았습니다. 입력된 값: [20220203]",
+  "data" : null
+}
+
+
+
+
+

Request parameters

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

orderDate

주문 날짜 YYYY-MM-DD

lastOrderId

페이지의 마지막 주문 고유 번호

+
+
+

Response fields

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

code

String

결과 코드 SUCCESS/ERROR

message

String

메시지

data

Null

데이터

+
+
+
+
+
+ + + + + + \ No newline at end of file diff --git a/store-service/src/docs/asciidoc/api-docs.adoc b/store-service/src/docs/asciidoc/api-docs.adoc new file mode 100644 index 0000000..15ce2f7 --- /dev/null +++ b/store-service/src/docs/asciidoc/api-docs.adoc @@ -0,0 +1,71 @@ +:doctype: book +:icons: font +:source-highlighter: highlightjs +:toc: left +:toclevels: 2 +:sectlinks: + + +[[overview]] += 개요 + +[[overview-http-verbs]] +== HTTP 동사 + +본 REST API에서 사용하는 HTTP 동사(verbs)는 가능한한 표준 HTTP와 REST 규약을 따릅니다. + +|=== +| 동사 | 용례 + +| `GET` +| 리소스를 가져올 때 사용 + +| `POST` +| 새 리소스를 만들 때 사용 + +| `PUT` +| 기존 리소스를 수정할 때 사용 + +| `PATCH` +| 기존 리소스의 일부를 수정할 때 사용 + +| `DELETE` +| 기존 리소스를 삭제할 떄 사용 +|=== + +[[overview-http-status-codes]] +== HTTP 상태 코드 + +본 REST API에서 사용하는 HTTP 상태 코드는 가능한 표준 HTTP와 REST 규약을 따릅니다. + +|=== +| 상태 코드 | 용례 + +| `200 OK` +| 요청을 성공적으로 처리함 + +| `201 Created` +| 새 리소스를 성공적으로 생성함. 응답의 `Location` 헤더에 해당 리소스의 URI가 담겨있다. + +| `204 No Content` +| 기존 리소스를 성공적으로 수정함. + +| `400 Bad Request` +| 잘못된 요청을 보낸 경우. 응답 본문에 더 오류에 대한 정보가 담겨있다. + +| `404 Not Found` +| 요청한 리소스가 없음. + +| `409 Conflict` +| 클라이언트의 요청이 서버의 상태와 충돌이 발생한 경우. +|=== + +[[snippets-write-convention]] +== snippets 작성 컨벤션 +domain-httpRequestCode-etc + +== 상품 +=== 상품 조회 +operation::item-get[snippets='curl-request,http-request,http-response,path-parameters,response-fields'] +=== 상품 조회 (존재하지 않는 상품) +operation::item-get-notExistItemException[snippets='curl-request,http-request,http-response,path-parameters,response-fields'] \ No newline at end of file diff --git a/store-service/src/main/resources/static/docs/api-docs.html b/store-service/src/main/resources/static/docs/api-docs.html new file mode 100644 index 0000000..590a541 --- /dev/null +++ b/store-service/src/main/resources/static/docs/api-docs.html @@ -0,0 +1,778 @@ + + + + + + + +개요 + + + + + + +
+
+

HTTP 동사

+
+
+

본 REST API에서 사용하는 HTTP 동사(verbs)는 가능한한 표준 HTTP와 REST 규약을 따릅니다.

+
+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
동사용례

GET

리소스를 가져올 때 사용

POST

새 리소스를 만들 때 사용

PUT

기존 리소스를 수정할 때 사용

PATCH

기존 리소스의 일부를 수정할 때 사용

DELETE

기존 리소스를 삭제할 떄 사용

+
+
+
+

HTTP 상태 코드

+
+
+

본 REST API에서 사용하는 HTTP 상태 코드는 가능한 표준 HTTP와 REST 규약을 따릅니다.

+
+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
상태 코드용례

200 OK

요청을 성공적으로 처리함

201 Created

새 리소스를 성공적으로 생성함. 응답의 Location 헤더에 해당 리소스의 URI가 담겨있다.

204 No Content

기존 리소스를 성공적으로 수정함.

400 Bad Request

잘못된 요청을 보낸 경우. 응답 본문에 더 오류에 대한 정보가 담겨있다.

404 Not Found

요청한 리소스가 없음.

409 Conflict

클라이언트의 요청이 서버의 상태와 충돌이 발생한 경우.

+
+
+
+

snippets 작성 컨벤션

+
+
+

domain-httpRequestCode-etc

+
+
+
+
+

상품

+
+
+

상품 조회

+
+

Curl request

+
+
+
$ curl 'http://127.0.0.1:8001/item/1' -i -X GET
+
+
+
+
+

HTTP request

+
+
+
GET /item/1 HTTP/1.1
+Host: 127.0.0.1:8001
+
+
+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 146
+
+{
+  "code" : "SUCCESS",
+  "message" : "",
+  "data" : {
+    "id" : 1,
+    "name" : "아메리카노",
+    "salesYn" : "Y",
+    "price" : 1500
+  }
+}
+
+
+
+
+

Path parameters

+ + ++++ + + + + + + + + + + + + +
Table 1. /item/{itemId}
ParameterDescription

itemId

상품 고유 번호

+
+
+

Response fields

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

code

String

결과 코드 SUCCESS/ERROR

message

String

메시지

data.id

Number

상품 고유 번호

data.name

String

상품 이름

data.salesYn

String

화면 표시 여부 Y/N

data.price

Number

상품 가격

+
+
+
+

상품 조회 (존재하지 않는 상품)

+
+

Curl request

+
+
+
$ curl 'http://127.0.0.1:8001/item/9999' -i -X GET
+
+
+
+
+

HTTP request

+
+
+
GET /item/9999 HTTP/1.1
+Host: 127.0.0.1:8001
+
+
+
+
+

HTTP response

+
+
+
HTTP/1.1 409 Conflict
+Content-Type: application/json
+Content-Length: 93
+
+{
+  "code" : "ERROR",
+  "message" : "존재하지 않는 상품입니다.",
+  "data" : null
+}
+
+
+
+
+

Path parameters

+ + ++++ + + + + + + + + + + + + +
Table 1. /item/{itemId}
ParameterDescription

itemId

상품 고유 번호

+
+
+

Response fields

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

code

String

결과 코드 SUCCESS/ERROR

message

String

메시지

data

Null

데이터

+
+
+
+
+
+ + + + + + \ No newline at end of file diff --git a/user-service/src/main/resources/static/docs/api-docs.html b/user-service/src/main/resources/static/docs/api-docs.html new file mode 100644 index 0000000..c8eb9e2 --- /dev/null +++ b/user-service/src/main/resources/static/docs/api-docs.html @@ -0,0 +1,772 @@ + + + + + + + +개요 + + + + + + +
+
+

HTTP 동사

+
+
+

본 REST API에서 사용하는 HTTP 동사(verbs)는 가능한한 표준 HTTP와 REST 규약을 따릅니다.

+
+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
동사용례

GET

리소스를 가져올 때 사용

POST

새 리소스를 만들 때 사용

PUT

기존 리소스를 수정할 때 사용

PATCH

기존 리소스의 일부를 수정할 때 사용

DELETE

기존 리소스를 삭제할 떄 사용

+
+
+
+

HTTP 상태 코드

+
+
+

본 REST API에서 사용하는 HTTP 상태 코드는 가능한 표준 HTTP와 REST 규약을 따릅니다.

+
+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
상태 코드용례

200 OK

요청을 성공적으로 처리함

201 Created

새 리소스를 성공적으로 생성함. 응답의 Location 헤더에 해당 리소스의 URI가 담겨있다.

204 No Content

기존 리소스를 성공적으로 수정함.

400 Bad Request

잘못된 요청을 보낸 경우. 응답 본문에 더 오류에 대한 정보가 담겨있다.

404 Not Found

요청한 리소스가 없음.

409 Conflict

클라이언트의 요청이 서버의 상태와 충돌이 발생한 경우.

+
+
+
+

snippets 작성 컨벤션

+
+
+

domain-httpRequestCode-etc

+
+
+
+
+

유저

+
+
+

회원 조회

+
+

Curl request

+
+
+
$ curl 'http://127.0.0.1:8001/customer/1' -i -X GET
+
+
+
+
+

HTTP request

+
+
+
GET /customer/1 HTTP/1.1
+Host: 127.0.0.1:8001
+
+
+
+
+

HTTP response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 141
+
+{
+  "code" : "SUCCESS",
+  "message" : "",
+  "data" : {
+    "userId" : 1,
+    "userName" : "이름",
+    "phoneNumber" : "010-1234-5678"
+  }
+}
+
+
+
+
+

Path parameters

+ + ++++ + + + + + + + + + + + + +
Table 1. /customer/{userId}
ParameterDescription

userId

회원 고유번호

+
+
+

Response fields

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

code

String

결과코드 SUCCESS/ERROR

message

String

메시지

data.userId

Number

회원 고유번호

data.userName

String

회원 이름

data.phoneNumber

String

회원 휴대폰 번호

+
+
+
+

회원 조회 (존재하지 않는 회원)

+
+

Curl request

+
+
+
$ curl 'http://127.0.0.1:8001/customer/9999' -i -X GET
+
+
+
+
+

HTTP request

+
+
+
GET /customer/9999 HTTP/1.1
+Host: 127.0.0.1:8001
+
+
+
+
+

HTTP response

+
+
+
HTTP/1.1 409 Conflict
+Content-Type: application/json
+Content-Length: 94
+
+{
+  "code" : "ERROR",
+  "message" : "존재하지 않는 회원 입니다.",
+  "data" : null
+}
+
+
+
+
+

Path parameters

+ + ++++ + + + + + + + + + + + + +
Table 1. /customer/{userId}
ParameterDescription

userId

회원 고유번호

+
+
+

Response fields

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

code

String

결과코드 SUCCESS/ERROR

message

String

메시지

data

Null

데이터

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