Skip to content

Commit

Permalink
docs(#19): 자주 묻는 질문 API 문서
Browse files Browse the repository at this point in the history
- 자주 묻는 질문 API 문서를 작성했어요.
  • Loading branch information
cabbage16 committed Nov 23, 2024
1 parent ad66d70 commit cebf8a0
Showing 1 changed file with 99 additions and 0 deletions.
99 changes: 99 additions & 0 deletions src/docs/asciidoc/question.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
== 자주 묻는 질문 Question

=== 자주 묻는 질문 생성
어드민 권한을 가진 사용자가 제목과 내용을 입력해 자주 묻는 질문을 생성할 수 있습니다.

==== 요청 형식

===== Request Header
include::{snippets}/question-controller-test/자주묻는질문을_생성한다/request-headers.adoc[]

===== Request Body
include::{snippets}/question-controller-test/자주묻는질문을_생성한다/request-fields.adoc[]

==== 요청
include::{snippets}/question-controller-test/자주묻는질문을_생성한다/http-request.adoc[]

==== 응답

===== 정상 응답
include::{snippets}/question-controller-test/자주묻는질문을_생성한다/http-response.adoc[]

=== 자주 묻는 질문 전체 조회
자주 묻는 질문을 조회할 수 있습니다.

==== 요청 형식

==== 요청
include::{snippets}/question-controller-test/자주묻는질문을_전체_조회한다/http-request.adoc[]

==== 응답

===== 정상 응답
include::{snippets}/question-controller-test/자주묻는질문을_전체_조회한다/http-response.adoc[]

=== 자주 묻는 질문 상세 조회
자주 묻는 질문을 상세 조회할 수 있습니다.

==== 요청 형식

===== Path Parameter
include::{snippets}/question-controller-test/자주묻는질문을_조회한다/path-parameters.adoc[]

==== 요청
include::{snippets}/question-controller-test/자주묻는질문을_조회한다/http-request.adoc[]

==== 응답

===== 정상 응답
include::{snippets}/question-controller-test/자주묻는질문을_조회한다/http-response.adoc[]

===== 자주 묻는 질문을 찾을 수 없는 경우
include::{snippets}/question-controller-test/자주묻는질문을_조회할_때_자주묻는질문이_없으면_예외가_발생한다/http-response.adoc[]

=== 자주 묻는 질문 수정
어드민은 자주 묻는 질문을 수정할 수 있습니다.

==== 요청 형식

===== Request Header
include::{snippets}/question-controller-test/자주묻는질문을_수정한다/request-headers.adoc[]

===== Path Parameter
include::{snippets}/question-controller-test/자주묻는질문을_수정한다/path-parameters.adoc[]

===== Request Fields
include::{snippets}/question-controller-test/자주묻는질문을_수정한다/request-fields.adoc[]

==== 요청
include::{snippets}/question-controller-test/자주묻는질문을_수정한다/http-request.adoc[]

==== 응답

===== 정상 응답
include::{snippets}/question-controller-test/자주묻는질문을_수정한다/http-response.adoc[]

===== 자주 묻는 질문을 찾을 수 없는 경우
include::{snippets}/question-controller-test/자주묻는질문을_수정할_때_자주묻는질문이_없으면_에러가_발생한다/http-response.adoc[]

=== 자주 묻는 질문 삭제
어드민은 자주 묻는 질문을 삭제할 수 있습니다.

==== 요청 형식

===== Request Header
include::{snippets}/question-controller-test/자주묻는질문을_삭제한다/request-headers.adoc[]

===== Path Parameter
include::{snippets}/question-controller-test/자주묻는질문을_삭제한다/path-parameters.adoc[]

==== 요청
include::{snippets}/question-controller-test/자주묻는질문을_삭제한다/http-request.adoc[]

==== 응답

===== 정상 응답
include::{snippets}/question-controller-test/자주묻는질문을_삭제한다/http-response.adoc[]

===== 자주 묻는 질문을 찾을 수 없는 경우
include::{snippets}/question-controller-test/자주묻는질문을_삭제할_때_자주묻는질문이_없으면_에러가_발생한다/http-response.adoc[]

0 comments on commit cebf8a0

Please sign in to comment.