mindol1004/spring-jwt
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'master' into publishing_page

Browse Source
This commit is contained in:
백창훈
2022-04-04 13:38:14 +09:00
committed by GitHub
parent 5c2e0d69a4 129dc49059
commit 360610e9f0
3 changed files with 57 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -60,10 +60,10 @@
### API 설계 ✏️ ### API 설계 ✏️
| 서비스 | 설계서 | | 서비스 | 설계서 |
| --- | --- | | --- | --- |
| USER-SERVICE | | | USER-SERVICE |[링크](https://development-team-1.github.io/just-pickup/User-Service-API-%EB%AC%B8%EC%84%9C/)|
| STORE-SERVICE | | | STORE-SERVICE |[링크](https://development-team-1.github.io/just-pickup/Store-Service-API-%E1%84%86%E1%85%AE%E1%86%AB%E1%84%89%E1%85%A5/)|
| ORDER-SERVICE | | | ORDER-SERVICE |[링크](https://development-team-1.github.io/just-pickup/Order-Service-API-%E1%84%86%E1%85%AE%E1%86%AB%E1%84%89%E1%85%A5/)|
| NOTIFICATION-SERVICE | | | NOTIFICATION-SERVICE |[링크](https://development-team-1.github.io/just-pickup/Notification-Service-API-%EB%AC%B8%EC%84%9C/)|

49
order-service/src/docs/asciidoc/api-docs.adoc
View File

@@ -63,40 +63,31 @@
== 주문 == 주문
=== 주문 수정 === 주문 수정
operation::order-patch[snippets='curl-request,http-request,http-response,path-parameters,request-fields,response-fields'] operation::order-patch[snippets='curl-request,http-request,http-response,path-parameters,request-fields,response-fields']
=== 주문 상세보기 === 주문 상세보기 조회
operation::api-orderDetail[snippets='curl-request,http-request,http-response,path-parameters,response-fields'] operation::api-orderDetail[snippets='curl-request,http-request,http-response,path-parameters,response-fields']
== 점주 서비스 == 주문 (사용자 서비스)
=== 주문 페이지 === 주문 내역 조회
- 페이지 offset : 6
operation::orderMain-get[snippets='curl-request,http-request,http-response,request-headers,request-parameters,response-fields']
=== 점주 서비스 - 주문 페이지 (잘못된 파라미터 형식)
operation::orderMain-get-badParameterException[snippets='curl-request,http-request,http-response,request-headers,request-parameters,response-fields']
=== 점주 서비스 - 지난 주문 페이지
operation::prevOrder-get[snippets='curl-request,http-request,http-response,request-headers,request-parameters,response-fields']
=== 점주 서비스 - 지난 주문 페이지 (잘못된 파라미터 형식)
operation::prevOrder-get-BindException[snippets='curl-request,http-request,http-response,request-headers,request-parameters,response-fields']
=== 점주 서비스 - 대쉬보드
operation::owner-findDashboard[snippets='curl-request,http-request,http-response,request-headers,response-fields']
== Just Pick-up
=== 주문 내역 페이지
operation::api-customer-order-history[snippets='curl-request,http-request,http-response,request-headers,request-parameters,response-fields'] operation::api-customer-order-history[snippets='curl-request,http-request,http-response,request-headers,request-parameters,response-fields']
=== 장바구니 상품 추가 === 장바구니 상품 추가
operation::add-item-to-basket[snippets='curl-request,http-request,http-response,request-headers,request-body,request-fields'] operation::add-item-to-basket[snippets='curl-request,http-request,http-response,request-headers,request-body,request-fields']
=== 장바구니 내역 조회
=== 장바구니 내역 가져오기
operation::fetch-order[snippets='curl-request,http-request,http-response,request-headers,response-fields'] operation::fetch-order[snippets='curl-request,http-request,http-response,request-headers,response-fields']
=== 주문 생성
operation::save-order[snippets='curl-request,http-request,http-response,request-headers']
=== 장바구니 상품 삭제 == 주문 (점주 서비스)
=== 주문 페이지 조회
operation::orderMain-get[snippets='curl-request,http-request,http-response,request-headers,request-parameters,response-fields']
=== 주문 페이지 조회 (잘못된 파라미터 형식)
operation::prevOrder-get-BindException[snippets='curl-request,http-request,http-response,request-headers,request-parameters,response-fields']
=== 지난 주문 페이지 조회
operation::prevOrder-get[snippets='curl-request,http-request,http-response,request-headers,request-parameters,response-fields']
=== 지난 주문 페이지 조회 (파라미터 오류)
operation::prevOrder-get-BindException[snippets='curl-request,http-request,http-response,request-headers,request-parameters,response-fields']
=== 대쉬보드 조회
operation::owner-findDashboard[snippets='curl-request,http-request,http-response,request-headers,response-fields']
== 주문상품 (사용자 서비스)
=== 장바구니 아이템 삭제
operation::delete-orderItem[snippets='curl-request,http-request,http-response,request-headers,path-parameters,response-fields'] operation::delete-orderItem[snippets='curl-request,http-request,http-response,request-headers,path-parameters,response-fields']
=== 주문하기
operation::save-order[snippets='curl-request,http-request,http-response,request-headers']

66
store-service/src/docs/asciidoc/api-docs.adoc
View File

@@ -60,59 +60,59 @@
| 클라이언트의 요청이 서버의 상태와 충돌이 발생한 경우. | 클라이언트의 요청이 서버의 상태와 충돌이 발생한 경우.
|=== |===
== 카테고리 (점주 서비스)
=== 카테고리 조회
operation::get-categoryList[snippets='curl-request,http-request,http-response,request-headers,response-fields']
== 상품 == 상품
=== 상품 조회 === 상품 조회
operation::item-get[snippets='curl-request,http-request,http-response,path-parameters,response-fields'] 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'] operation::item-get-notExistItemException[snippets='curl-request,http-request,http-response,path-parameters,response-fields']
=== 상품 리스트 조회 === 상품 리스트 조회
operation::items-get[snippets='curl-request,http-request,http-response,path-parameters,response-fields'] operation::items-get[snippets='curl-request,http-request,http-response,path-parameters,response-fields']
== 상품 (점주 서비스)
== 상품 (판매자)
=== 상품 조회
=== 상품 리스트 조회(구매자)
operation::customer-itemList-get[snippets='curl-request,http-request,http-response,path-parameters,response-fields']
=== 상품 조회(판매자)
operation::owner-item-get[snippets='curl-request,http-request,http-response,path-parameters,response-fields']
=== 상품 리스트 조회 === 상품 리스트 조회
operation::owner-itemList-get[snippets='curl-request,http-request,http-response,response-fields'] operation::owner-itemList-get[snippets='curl-request,http-request,http-response,request-headers,request-parameters,response-fields']
=== 상품 조회
=== 상품 수정 operation::owner-item-get[snippets='curl-request,http-request,http-response,path-parameters,response-fields']
operation::owner-put-item[snippets='curl-request,http-request,http-response']
=== 상품 등록 === 상품 등록
operation::owner-create-item[snippets='curl-request,http-request,http-response'] operation::owner-create-item[snippets='curl-request,http-request,http-response,request-headers,request-fields']
=== 상품 수정
== 카테고리 operation::owner-put-item[snippets='curl-request,http-request,http-response,request-headers,request-fields']
== 카테고리 조회
operation::get-categoryList[snippets='curl-request,http-request,http-response,request-parameters,response-fields']
== 카테고리 수정
operation::put-categoryList[snippets='curl-request,http-request,http-response,request-body,request-fields']
== 상품 (사용자 서비스)
=== 상품 리스트 조회
operation::customer-itemList-get[snippets='curl-request,http-request,http-response,path-parameters,response-fields']
=== 상품 조회
operation::customer-item-get[snippets='curl-request,http-request,http-response,path-parameters,response-fields']
== 매장 == 매장
=== 매장 검색 조회
operation::api-customer-store-search[snippets='curl-request,http-request,http-response,request-parameters,response-fields']
=== 자주찾는 매장
operation::favoriteStore-get[snippets='curl-request,http-request,http-response,request-headers,request-parameters,response-fields']
=== 매장 조회 === 매장 조회
operation::store-get[snippets='curl-request,http-request,http-response,path-parameters,response-fields'] operation::store-get[snippets='curl-request,http-request,http-response,path-parameters,response-fields']
=== 매장 조회 (회원 고유번호)
operation::api-get-store-byUserId[snippets='curl-request,http-request,http-response,request-headers,response-fields']
=== 매장 리스트 조회 === 매장 리스트 조회
operation::stores-get[snippets='curl-request,http-request,http-response,path-parameters,response-fields'] operation::stores-get[snippets='curl-request,http-request,http-response,path-parameters,response-fields']
=== 매장 생성 (점주 서비스)
== 매장 (점주 서비스)
=== 사용자 고유번호로 매장 조회
operation::api-get-store-byUserId[snippets='curl-request,http-request,http-response,request-headers,response-fields']
=== 매장 등록
operation::api-post-store[snippets='curl-request,http-request,http-response,request-headers,request-fields'] operation::api-post-store[snippets='curl-request,http-request,http-response,request-headers,request-fields']
== 즐겨찾는 매장 == 매장 (사용자 서비스)
=== 즐겨찾는 매장 조회
operation::favoriteStore-get[snippets='curl-request,http-request,http-response,request-headers,request-parameters,response-fields']
=== 매장 검색 조회
operation::api-customer-store-search[snippets='curl-request,http-request,http-response,request-parameters,response-fields']
// itemcustomerapicontrollertest
== 즐겨찾는 매장 (사용자 서비스)
=== 즐겨찾는 매장 조회 === 즐겨찾는 매장 조회
operation::get-favoritestore-by-storeid[snippets='curl-request,http-request,http-response,request-headers,path-parameters,response-fields'] operation::get-favoritestore-by-storeid[snippets='curl-request,http-request,http-response,request-headers,path-parameters,response-fields']
=== 즐겨찾는 매장 추가/삭제
=== 즐겨찾는 매장 추가 | 제거
operation::patch-FavoriteStore[snippets='curl-request,http-request,http-response,request-headers,path-parameters'] operation::patch-FavoriteStore[snippets='curl-request,http-request,http-response,request-headers,path-parameters']
operation::customer-item-get[snippets='curl-request,http-request,http-response,path-parameters,response-fields']