Skip to content

Commit

Permalink
docs: UserLibrary API Docs 작성 (#86)
Browse files Browse the repository at this point in the history
  • Loading branch information
jwooo committed Apr 29, 2024
1 parent 58da4bc commit 51a9a59
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 1 deletion.
62 changes: 62 additions & 0 deletions src/docs/asciidoc/api/userlibrary/userlibrary.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
=== 서재 단건 조회

image::https://jisungin-bucket.s3.ap-northeast-2.amazonaws.com/docs/get-userlibrary.png[]

TIP: 상세 조회된 도서에 대한 사용자의 도서 상태를 조회

==== HTTP Request
include::{snippets}/user-library/get/http-request.adoc[]
include::{snippets}/user-library/get/query-parameters.adoc[]

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

=== 서재 등록

TIP: 상세 조회된 도서에 대한 도서 상태를 생성

==== HTTP Request
include::{snippets}/user-library/create/http-request.adoc[]
===== Request Body
include::{snippets}/user-library/create/request-body.adoc[]
include::{snippets}/user-library/create/request-fields.adoc[]

==== HTTP Response
include::{snippets}/user-library/create/http-response.adoc[]
===== Response Body
include::{snippets}/user-library/create/response-body.adoc[]
include::{snippets}/user-library/create/response-fields.adoc[]

=== 서재 수정

TIP: 상세 조회된 도서에 대한 도서 상태를 수정

==== HTTP Request
include::{snippets}/user-library/edit/http-request.adoc[]
include::{snippets}/user-library/edit/path-parameters.adoc[]
===== Request Body
include::{snippets}/user-library/edit/request-body.adoc[]
include::{snippets}/user-library/edit/request-fields.adoc[]

==== HTTP Response
include::{snippets}/user-library/edit/http-response.adoc[]
===== Response Body
include::{snippets}/user-library/edit/response-body.adoc[]
include::{snippets}/user-library/edit/response-fields.adoc[]

=== 서재 삭제

TIP: 상세 조회된 도서에 대한 도서 상태를 삭제

==== HTTP Request
include::{snippets}/user-library/delete/http-request.adoc[]

==== HTTP Response
include::{snippets}/user-library/delete/http-response.adoc[]
include::{snippets}/user-library/delete/path-parameters.adoc[]
===== Response Body
include::{snippets}/user-library/delete/response-body.adoc[]
include::{snippets}/user-library/delete/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 @@ -37,4 +37,8 @@ include::api/image/image.adoc[]
[[Book-API]]
== Book API

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

[[UserLibrary-API]]
== UserLibrary API
include::api/userlibrary/userlibrary.adoc[]

0 comments on commit 51a9a59

Please sign in to comment.