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

feat : Rest Docs 명세화 #99

Merged
merged 11 commits into from
Jan 12, 2024
60 changes: 58 additions & 2 deletions src/docs/asciidoc/api/waiting/waiting.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[waiting-create]]
=== 웨이팅 등록
=== 웨이팅 등록 API

==== HTTP Request

Expand All @@ -9,4 +9,60 @@ include::{snippets}/member-waiting-controller-docs-test/create-waiting/request-f
==== HTTP Response

include::{snippets}/member-waiting-controller-docs-test/create-waiting/http-response.adoc[]
include::{snippets}/member-waiting-controller-docs-test/create-waiting/response-fields.adoc[]
include::{snippets}/member-waiting-controller-docs-test/create-waiting/response-fields.adoc[]

=== 웨이팅 지연 API

==== HTTP Request

include::{snippets}/member-waiting-controller-docs-test/postpone-waiting/http-request.adoc[]

==== HTTP Response

include::{snippets}/member-waiting-controller-docs-test/postpone-waiting/http-response.adoc[]
include::{snippets}/member-waiting-controller-docs-test/postpone-waiting/response-fields.adoc[]

=== 웨이팅 취소 API

==== HTTP Request

include::{snippets}/member-waiting-controller-docs-test/cancel-waiting/http-request.adoc[]

==== HTTP Response

include::{snippets}/member-waiting-controller-docs-test/cancel-waiting/http-response.adoc[]
include::{snippets}/member-waiting-controller-docs-test/cancel-waiting/response-fields.adoc[]

=== 회원 진행 중인 웨이팅 조회 API

==== HTTP Request

include::{snippets}/member-waiting-controller-docs-test/get-waiting/http-request.adoc[]

==== HTTP Response

include::{snippets}/member-waiting-controller-docs-test/get-waiting/http-response.adoc[]
include::{snippets}/member-waiting-controller-docs-test/get-waiting/response-fields.adoc[]


=== 웨이팅 입장 API

==== HTTP Request

include::{snippets}/owner-waiting-controller-docs-test/entry-waiting/http-request.adoc[]

==== HTTP Response

include::{snippets}/owner-waiting-controller-docs-test/entry-waiting/http-response.adoc[]
include::{snippets}/owner-waiting-controller-docs-test/entry-waiting/response-fields.adoc[]

=== 가게 웨이팅 이력 조회 API

==== HTTP Request

include::{snippets}/owner-waiting-controller-docs-test/get-shop-all-waiting/http-request.adoc[]

==== HTTP Response

include::{snippets}/owner-waiting-controller-docs-test/get-shop-all-waiting/http-response.adoc[]
include::{snippets}/owner-waiting-controller-docs-test/get-shop-all-waiting/response-fields.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ public class OwnerWaitingController {
private final OwnerWaitingService ownerWaitingService;

@GetMapping
public ResponseEntity<OwnerWaitingListResponse> getOwnerAllWaiting(
public ResponseEntity<OwnerWaitingListResponse> getShopAllWaiting(
@LogIn Owner owner) {
OwnerWaitingListResponse response = ownerWaitingService.getOwnerAllWaiting(owner);
OwnerWaitingListResponse response = ownerWaitingService.getShopAllWaiting(owner);
return ResponseEntity.ok(response);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ public static MemberWaitingHistoryResponse toMemberWaitingHistoryResponse(Waitin
.shopId(waiting.getShop().getId())
.shopName(waiting.getShop().getName())
.peopleCount(waiting.getPeopleCount())
.waitingNumber(waiting.getWaitingNumber())
.status(waiting.getStatus().getDescription())
.build();
}
Expand All @@ -66,6 +65,7 @@ public static OwnerWaitingResponse toOwnerWaitingResponse(Waiting waiting, Long
.waitingNumber(waiting.getWaitingNumber())
.rank(rank)
.peopleCount(waiting.getPeopleCount())
.status(waiting.getStatus().getDescription())
.build();
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
package com.prgrms.catchtable.waiting.dto.response;

import java.util.List;
import lombok.Builder;

@Builder
public record MemberWaitingHistoryListResponse(
List<MemberWaitingHistoryResponse> memberWaitings
) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ public record MemberWaitingHistoryResponse(
Long shopId,
String shopName,
int peopleCount,
int waitingNumber,
String status
) {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ public record OwnerWaitingResponse(
Long waitingId,
int waitingNumber,
Long rank,
int peopleCount
int peopleCount,
String status
) {

}
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public class OwnerWaitingService {
private final WaitingLineRepository waitingLineRepository;

@Transactional(readOnly = true)
public OwnerWaitingListResponse getOwnerAllWaiting(Owner owner) {
public OwnerWaitingListResponse getShopAllWaiting(Owner owner) {
List<Long> waitingIds = waitingLineRepository.getShopWaitingIdsInOrder(
owner.getShop().getId());
List<Waiting> waitings = waitingRepository.findByIds(waitingIds);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
package com.prgrms.catchtable.common.restdocs;

import static com.prgrms.catchtable.common.Role.*;
import static com.prgrms.catchtable.common.Role.MEMBER;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.prgrms.catchtable.common.Role;
import com.prgrms.catchtable.jwt.provider.JwtTokenProvider;
import com.prgrms.catchtable.jwt.token.Token;
import com.prgrms.catchtable.member.domain.Member;
import com.prgrms.catchtable.owner.domain.Owner;
import jakarta.servlet.ServletException;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.extension.ExtendWith;
Expand Down Expand Up @@ -68,4 +71,11 @@ public HttpHeaders getHttpHeaders(Member member) {
httpHeaders.add("RefreshToken", token.getRefreshToken());
return httpHeaders;
}

public HttpHeaders getHttpHeaders(Owner owner) {
Token token = jwtTokenProvider.createToken(owner.getEmail(), OWNER);
httpHeaders.add("AccessToken", token.getAccessToken());
httpHeaders.add("RefreshToken", token.getRefreshToken());
return httpHeaders;
}
}
Loading