Skip to content

Commit

Permalink
Merge pull request #117 from dev-hooon/chore/#116/rest-docs-res
Browse files Browse the repository at this point in the history
chore: RestDocs 예약 API 반영
  • Loading branch information
hyun2371 authored Jan 18, 2024
2 parents 4c4b6c7 + 41fe6e2 commit e7299bf
Show file tree
Hide file tree
Showing 2 changed files with 85 additions and 1 deletion.
80 changes: 80 additions & 0 deletions src/docs/asciidoc/api/reservation/reservation.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
[[reservation-create]]
=== 예약 선점 API

==== HTTP Request

include::{snippets}/member-reservation-controller-docs-test/pre-occupy/http-request.adoc[]
include::{snippets}/member-reservation-controller-docs-test/pre-occupy/request-fields.adoc[]

==== HTTP Response

include::{snippets}/member-reservation-controller-docs-test/pre-occupy/http-response.adoc[]
include::{snippets}/member-reservation-controller-docs-test/pre-occupy/response-fields.adoc[]

=== 가게 예약 API

==== HTTP Request

include::{snippets}/member-reservation-controller-docs-test/register/http-request.adoc[]
include::{snippets}/member-reservation-controller-docs-test/register/request-fields.adoc[]

==== HTTP Response

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

=== 예약 전체 조회 API

==== HTTP Request

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

==== HTTP Response

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

=== 예약 수정 API

==== HTTP Request

include::{snippets}/member-reservation-controller-docs-test/modify/http-request.adoc[]
include::{snippets}/member-reservation-controller-docs-test/modify/request-fields.adoc[]

==== HTTP Response

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

=== 예약 삭제 API

==== HTTP Request

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

==== HTTP Response

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

=== 예약 노쇼, 취소 처리 API

==== HTTP Request

include::{snippets}/owner-reservation-controller-docs-test/noshow-and-cancel/http-request.adoc[]
include::{snippets}/owner-reservation-controller-docs-test/noshow-and-cancel/request-fields.adoc[]

==== HTTP Response

include::{snippets}/owner-reservation-controller-docs-test/noshow-and-cancel/http-response.adoc[]

=== 예약 정보 전체 조회 API

==== HTTP Request

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

==== HTTP Response

include::{snippets}/owner-reservation-controller-docs-test/get-all-reservation/http-response.adoc[]
include::{snippets}/owner-reservation-controller-docs-test/get-all-reservation/response-fields.adoc[]
6 changes: 5 additions & 1 deletion src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,8 @@ endif::[]
[[CatchTable-API]]
== Waiting API

include::api/waiting/waiting.adoc[]
include::api/waiting/waiting.adoc[]

== Reservation API

include::api/reservation/reservation.adoc[]

0 comments on commit e7299bf

Please sign in to comment.