Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: yaml 파일 및 readme 수정 #84

Merged
merged 10 commits into from
Nov 30, 2023
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ out/
.vscode/

### Application.yaml ###
**/*.yaml

### Test Application.yaml ###
**/test/resources/application.yaml

### REST Docs Html ###
**/*.html
Expand Down
106 changes: 103 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,109 @@

## 멤버

- 👩🏻‍💻 [정의정](https://github.com/JeongUijeong)
- 👩🏻‍💻 [심재철](https://github.com/wocjf0513)
- 👩🏻‍💻 [이주연](https://github.com/jo0oy)
<table>
</tr>
<tr>
<td align="center" width="150px">
<a href="https://github.com/JeongUijeong" target="_blank">
<img src="https://github.com/Shimpyo-House/Shimpyo_FE/assets/98576512/bc2ef8d5-a063-4473-991b-92df77fb0263" alt="정의정 프로필" />
</a>
</td>
<td align="center" width="150px">
<a href="https://github.com/wocjf0513" target="_blank">
<img src="https://github.com/Shimpyo-House/Shimpyo_FE/assets/98576512/b6cdb1b6-76dd-4136-a6c5-eecb9ca0c2ab" alt="심재철 프로필" />
</a>
</td>
<td align="center" width="150px">
<a href="https://github.com/jo0oy" target="_blank">
<img src="https://github.com/Shimpyo-House/Shimpyo_FE/assets/98576512/29a0dfc6-8e91-4f5f-a5bd-43b7b668f4a6" alt="이주연 프로필" />
</a>
</td>
</tr>
<tr>
<td align="center">
<a href="https://github.com/JeongUijeong" target="_blank">
정의정<br />
Backend
</a>
</td>
<td align="center">
<a href="https://github.com/wocjf0513" target="_blank">
심재철<br />
Backend
</a>
</td>
<td align="center">
<a href="https://github.com/jo0oy" target="_blank">
이주연<br />
Backend
</a>
</td>
</tr>
</table>
<table>
<tr>
<td align="center" width="150px">
<a href="https://github.com/TaePoong719" target="_blank">
<img src="https://avatars.githubusercontent.com/u/98576512?v=4" alt="최우혁 프로필" />
</a>
</td>
<td align="center" width="150px">
<a href="https://github.com/jiohjung98" target="_blank">
<img src="https://github.com/Shimpyo-House/Shimpyo_FE/assets/104253583/cab3f3cc-ccb0-46cc-8b36-bf645b5c4086" alt="정지오 프로필" />
</a>
</td>
<td align="center" width="150px">
<a href="https://github.com/Yamyam-code" target="_blank">
<img src="https://github.com/KDT1-FE/Y_FE_Toy1/assets/39702832/58fb577d-9f8c-4679-bca1-8ff15ca84f6b" alt="백상원 프로필" />
</a>
</td>
<td align="center" width="150px">
<a href="https://github.com/wkdtnqls0506" target="_blank">
<img src="https://github.com/Shimpyo-House/Shimpyo_FE/assets/93272421/9b7ea286-4768-4d55-a26e-fc0541824b71" alt="장수빈 프로필" />
</a>
</td>
<td align="center" width="150px">
<a href="https://github.com/seacrab808" target="_blank">
<img src="https://github.com/Shimpyo-House/Shimpyo_FE/assets/93272421/6b9601d2-eec9-4887-8041-f98ed2f319d2" alt="소유나 프로필" />
</a>
</td>

</tr>
<tr>
<td align="center">
<a href="https://github.com/TaePoong719" target="_blank">
최우혁<br />
Frontend
</a>
</td>
<td align="center">
<a href="https://github.com/jiohjung98" target="_blank">
정지오<br />
Frontend
</a>
</td>
<td align="center">
<a href="https://github.com/Yamyam-code" target="_blank">
백상원<br />
Frontend
</a>
</td>
<td align="center">
<a href="https://github.com/wkdtnqls0506" target="_blank">
장수빈<br />
Frontend
</a>
</td>
<td align="center">
<a href="https://github.com/seacrab808" target="_blank">
소유나<br />
Frontend
</a>
</td>
</table>
<br>


---

Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/application.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
spring:
profiles:
default: local
default: prod
Binary file modified src/main/resources/image/reservation-docs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/main/resources/image/star-docs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -115,16 +115,16 @@ void saveReservation() throws Exception {
fieldWithPath("reservationProducts[].roomId").type(JsonFieldType.NUMBER).description("예약할 객실 식별자")
.attributes(key("constraints").value(
reservationProductDescriptions.descriptionsForProperty("roomId"))),
fieldWithPath("reservationProducts[].productName").type(JsonFieldType.STRING).description("예약할 객실 식별자")
fieldWithPath("reservationProducts[].productName").type(JsonFieldType.STRING).description("예약할 숙소명")
.attributes(key("constraints").value(
reservationProductDescriptions.descriptionsForProperty("productName"))),
fieldWithPath("reservationProducts[].roomName").type(JsonFieldType.STRING).description("예약할 객실 식별자")
fieldWithPath("reservationProducts[].roomName").type(JsonFieldType.STRING).description("예약할 객실명")
.attributes(key("constraints").value(
reservationProductDescriptions.descriptionsForProperty("roomName"))),
fieldWithPath("reservationProducts[].standard").type(JsonFieldType.NUMBER).description("예약할 객실 식별자")
fieldWithPath("reservationProducts[].standard").type(JsonFieldType.NUMBER).description("객실 기준 인원")
.attributes(key("constraints").value(
reservationProductDescriptions.descriptionsForProperty("standard"))),
fieldWithPath("reservationProducts[].max").type(JsonFieldType.NUMBER).description("예약할 객실 식별자")
fieldWithPath("reservationProducts[].max").type(JsonFieldType.NUMBER).description("객실 최대 인원")
.attributes(key("constraints").value(
reservationProductDescriptions.descriptionsForProperty("max"))),
fieldWithPath("reservationProducts[].startDate").type(JsonFieldType.STRING).description("숙박 시작일")
Expand All @@ -133,19 +133,19 @@ void saveReservation() throws Exception {
fieldWithPath("reservationProducts[].endDate").type(JsonFieldType.STRING).description("숙박 마지막일")
.attributes(key("constraints").value(
reservationProductDescriptions.descriptionsForProperty("endDate"))),
fieldWithPath("reservationProducts[].checkIn").type(JsonFieldType.STRING).description("예약할 객실 식별자")
fieldWithPath("reservationProducts[].checkIn").type(JsonFieldType.STRING).description("체크인 시간")
.attributes(key("constraints").value(
reservationProductDescriptions.descriptionsForProperty("checkIn"))),
fieldWithPath("reservationProducts[].checkOut").type(JsonFieldType.STRING).description("예약할 객실 식별자")
fieldWithPath("reservationProducts[].checkOut").type(JsonFieldType.STRING).description("체크아웃 시간")
.attributes(key("constraints").value(
reservationProductDescriptions.descriptionsForProperty("checkOut"))),
fieldWithPath("reservationProducts[].visitorName").type(JsonFieldType.STRING).description("예약할 객실 식별자")
fieldWithPath("reservationProducts[].visitorName").type(JsonFieldType.STRING).description("방문자명")
.attributes(key("constraints").value(
reservationProductDescriptions.descriptionsForProperty("visitorName"))),
fieldWithPath("reservationProducts[].visitorPhone").type(JsonFieldType.STRING).description("예약할 객실 식별자")
fieldWithPath("reservationProducts[].visitorPhone").type(JsonFieldType.STRING).description("방문자 전화번호")
.attributes(key("constraints").value(
reservationProductDescriptions.descriptionsForProperty("visitorPhone"))),
fieldWithPath("reservationProducts[].price").type(JsonFieldType.NUMBER).description("예약할 객실 식별자")
fieldWithPath("reservationProducts[].price").type(JsonFieldType.NUMBER).description("객실 이용 가격")
.attributes(key("constraints").value(
reservationProductDescriptions.descriptionsForProperty("price"))),
fieldWithPath("payMethod").type(JsonFieldType.STRING).description("결제 수단")
Expand All @@ -158,9 +158,9 @@ void saveReservation() throws Exception {
),
responseFields(responseCommon()).and(
fieldWithPath("data").type(JsonFieldType.OBJECT).description("응답 데이터"),
fieldWithPath("data.reservationId").type(JsonFieldType.NUMBER).description("예약 주문 식별자"),
fieldWithPath("data.reservationId").type(JsonFieldType.NUMBER).description("예약 식별자"),
fieldWithPath("data.reservationProducts").type(JsonFieldType.ARRAY).description("예약 상품 리스트"),
fieldWithPath("data.reservationProducts[].roomId").type(JsonFieldType.NUMBER).description("예약 상품 리스트"),
fieldWithPath("data.reservationProducts[].roomId").type(JsonFieldType.NUMBER).description("객실 식별자"),
fieldWithPath("data.reservationProducts[].productName").type(JsonFieldType.STRING).description("숙소명"),
fieldWithPath("data.reservationProducts[].roomName").type(JsonFieldType.STRING).description("객실명"),
fieldWithPath("data.reservationProducts[].standard").type(JsonFieldType.NUMBER).description("기준 인원"),
Expand Down Expand Up @@ -239,8 +239,8 @@ void getReservationInfoList() throws Exception {
fieldWithPath("data.content.[].productAddress").type(JsonFieldType.STRING).description("숙소 주소"),
fieldWithPath("data.content.[].roomId").type(JsonFieldType.NUMBER).description("예약한 객실 식별자"),
fieldWithPath("data.content.[].roomName").type(JsonFieldType.STRING).description("객실명"),
fieldWithPath("data.content.[].startDate").type(JsonFieldType.STRING).description("체크인 날짜"),
fieldWithPath("data.content.[].endDate").type(JsonFieldType.STRING).description("체크아웃 날짜"),
fieldWithPath("data.content.[].startDate").type(JsonFieldType.STRING).description("숙박 시작일"),
fieldWithPath("data.content.[].endDate").type(JsonFieldType.STRING).description("숙박 마지막일"),
fieldWithPath("data.content.[].checkIn").type(JsonFieldType.STRING).description("체크인 시간"),
fieldWithPath("data.content.[].checkOut").type(JsonFieldType.STRING).description("체크아웃 시간"),
fieldWithPath("data.content.[].price").type(JsonFieldType.NUMBER).description("결제 금액"),
Expand Down
19 changes: 0 additions & 19 deletions src/test/resources/application.yaml

This file was deleted.