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.

Sign up for GitHub

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

[Docs] Book REST Docs 작성 #84

Merged
merged 2 commits into from
Apr 23, 2024
Merged

[Docs] Book REST Docs 작성 #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3182ea3
test: Book API REST Docs 테스트 작성 (#81)
jwooo Apr 16, 2024
1bcf896
docs: Book API REST Docs 작성 (#81)
jwooo Apr 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions src/docs/asciidoc/api/book/book.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
=== 도서 단건 조회
==== HTTP Request
include::{snippets}/book/get/http-request.adoc[]
include::{snippets}/book/get/path-parameters.adoc[]

==== HTTP Response
include::{snippets}/book/get/http-response.adoc[]
===== Request Body
include::{snippets}/book/get/response-body.adoc[]
include::{snippets}/book/get/response-fields.adoc[]

=== 도서 페이징 조회
==== HTTP Request
include::{snippets}/book/get-all/http-request.adoc[]
include::{snippets}/book/get-all/query-parameters.adoc[]

==== HTTP Response
include::{snippets}/book/get-all/http-response.adoc[]
===== Response Body
include::{snippets}/book/get-all/response-body.adoc[]
include::{snippets}/book/get-all/response-fields.adoc[]

=== 도서 관련 토크방 조회
==== HTTP Request
include::{snippets}/book/get-related-talkRooms/http-request.adoc[]
include::{snippets}/book/get-related-talkRooms/path-parameters.adoc[]
include::{snippets}/book/get-related-talkRooms/query-parameters.adoc[]

==== HTTP Response
include::{snippets}/book/get-related-talkRooms/http-response.adoc[]
===== Response Body
include::{snippets}/book/get-related-talkRooms/response-body.adoc[]
include::{snippets}/book/get-related-talkRooms/response-fields.adoc[]

=== 베스트 셀러 조회
==== HTTP Request
include::{snippets}/book/get-best-seller/http-request.adoc[]
include::{snippets}/book/get-best-seller/query-parameters.adoc[]

==== HTTP Response
include::{snippets}/book/get-best-seller/http-response.adoc[]
===== Response Body
include::{snippets}/book/get-best-seller/response-body.adoc[]
include::{snippets}/book/get-best-seller/response-fields.adoc[]

=== 도서 생성
==== HTTP Request
include::{snippets}/book/create/http-request.adoc[]
===== Request Body
include::{snippets}/book/create/request-body.adoc[]
include::{snippets}/book/create/request-fields.adoc[]

==== HTTP Response
include::{snippets}/book/create/http-response.adoc[]
===== Response Body
include::{snippets}/book/create/response-body.adoc[]
include::{snippets}/book/create/response-fields.adoc[]
7 changes: 6 additions & 1 deletion src/docs/asciidoc/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,9 @@ include::api/commentlike/commentlike.adoc[]
[[Image-API]]
== Image API

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

[[Book-API]]
== Book API

include::api/book/book.adoc[]
Loading
Loading