docs: #293 채팅 api 문서화 (#296)

* 채팅 api 문서화 * docs: 채팅 api 문서화 request-headers 추가 및 항목 순서 변경 * docs: merge로 인한 충돌 해결 * fix: 빌드 후 변경사항 적용
woowacourse-teams · Aug 16, 2023 · a3b0967 · a3b0967
1 parent 49c5f9d
commit a3b0967
Show file tree

Hide file tree

Showing 3 changed files with 1,025 additions and 203 deletions.
diff --git a/backend/ddang/src/docs/asciidoc/docs.adoc b/backend/ddang/src/docs/asciidoc/docs.adoc
@@ -212,6 +212,73 @@ include::{snippets}/bid-controller-test/특정_경매에_대한_입찰_목록을
 include::{snippets}/bid-controller-test/특정_경매에_대한_입찰_목록을_조회한다/http-response.adoc[]
 include::{snippets}/bid-controller-test/특정_경매에_대한_입찰_목록을_조회한다/response-fields.adoc[]
 
+== 채팅 API
+
+=== 채팅방 등록
+
+==== 요청
+
+include::{snippets}/chat-room-controller-test/채팅방을_생성한다/http-request.adoc[]
+include::{snippets}/chat-room-controller-test/채팅방을_생성한다/request-headers.adoc[]
+include::{snippets}/chat-room-controller-test/채팅방을_생성한다/request-fields.adoc[]
+
+==== 응답
+
+include::{snippets}/chat-room-controller-test/채팅방을_생성한다/http-response.adoc[]
+include::{snippets}/chat-room-controller-test/채팅방을_생성한다/response-fields.adoc[]
+
+=== 채팅방 목록 조회
+
+==== 요청
+
+include::{snippets}/chat-room-controller-test/사용자가_참여한_모든_채팅방을_조회한다/http-request.adoc[]
+include::{snippets}/chat-room-controller-test/사용자가_참여한_모든_채팅방을_조회한다/request-headers.adoc[]
+
+==== 응답
+
+include::{snippets}/chat-room-controller-test/사용자가_참여한_모든_채팅방을_조회한다/http-response.adoc[]
+include::{snippets}/chat-room-controller-test/사용자가_참여한_모든_채팅방을_조회한다/response-fields.adoc[]
+
+=== 채팅방 상세 조회
+
+==== 요청
+
+include::{snippets}/chat-room-controller-test/지정한_아이디에_해당하는_채팅방을_조회한다/http-request.adoc[]
+include::{snippets}/chat-room-controller-test/지정한_아이디에_해당하는_채팅방을_조회한다/path-parameters.adoc[]
+include::{snippets}/chat-room-controller-test/지정한_아이디에_해당하는_채팅방을_조회한다/request-headers.adoc[]
+
+==== 응답
+
+include::{snippets}/chat-room-controller-test/지정한_아이디에_해당하는_채팅방을_조회한다/http-response.adoc[]
+include::{snippets}/chat-room-controller-test/지정한_아이디에_해당하는_채팅방을_조회한다/response-fields.adoc[]
+
+=== 메시지 전송
+
+==== 요청
+
+include::{snippets}/chat-room-controller-test/메시지를_생성한다/http-request.adoc[]
+include::{snippets}/chat-room-controller-test/메시지를_생성한다/path-parameters.adoc[]
+include::{snippets}/chat-room-controller-test/메시지를_생성한다/request-headers.adoc[]
+include::{snippets}/chat-room-controller-test/메시지를_생성한다/request-fields.adoc[]
+
+==== 응답
+
+include::{snippets}/chat-room-controller-test/메시지를_생성한다/http-response.adoc[]
+include::{snippets}/chat-room-controller-test/메시지를_생성한다/response-fields.adoc[]
+
+=== 메시지 목록 조회
+
+==== 요청
+
+include::{snippets}/chat-room-controller-test/마지막_조회_메시지_이후_메시지를_조회한다/http-request.adoc[]
+include::{snippets}/chat-room-controller-test/마지막_조회_메시지_이후_메시지를_조회한다/path-parameters.adoc[]
+include::{snippets}/chat-room-controller-test/마지막_조회_메시지_이후_메시지를_조회한다/request-headers.adoc[]
+include::{snippets}/chat-room-controller-test/마지막_조회_메시지_이후_메시지를_조회한다/query-parameters.adoc[]
+
+==== 응답
+include::{snippets}/chat-room-controller-test/마지막_조회_메시지_이후_메시지를_조회한다/http-response.adoc[]
+include::{snippets}/chat-room-controller-test/마지막_조회_메시지_이후_메시지를_조회한다/response-fields.adoc[]
+
 == 신고 API
 
 === 경매 신고 등록