Skip to content

Commit

Permalink
merge: restdocs 순서 변경
Browse files Browse the repository at this point in the history
docs: restdocs 순서 변경
  • Loading branch information
hong-sile authored Oct 10, 2023
2 parents 26376df + fd5dafb commit 5a3d1a8
Showing 1 changed file with 73 additions and 72 deletions.
145 changes: 73 additions & 72 deletions backend/emm-sale/src/documentTest/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,18 @@ include::{snippets}/delete-member/http-request.adoc[]
.HTTP response
include::{snippets}/delete-member/http-response.adoc[]

=== `PATCH` : 사용자의 프로필을 변경한다.

.HTTP request
```http
PATCH /members/2/profile HTTP/1.1
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Host: localhost:8080
```

.HTTP response
include::{snippets}/update-profile/http-response.adoc[]

== InterestTag

=== `GET` : 사용자의 관심 태그 조회
Expand Down Expand Up @@ -178,31 +190,8 @@ include::{snippets}/delete-interest-tag/http-response.adoc[]
.HTTP response 설명
include::{snippets}/delete-interest-tag/response-fields.adoc[]

=== `PATCH` : 사용자의 프로필을 변경한다.

.HTTP request
```http
POST /members/2/profile HTTP/1.1
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Host: localhost:8080
```

.HTTP response
include::{snippets}/update-profile/http-response.adoc[]

== Event

=== `GET` : 행사 상세정보 조회

.HTTP request
include::{snippets}/find-event/http-request.adoc[]

.HTTP response
include::{snippets}/find-event/http-response.adoc[]

.HTTP response 설명
include::{snippets}/find-event/response-fields.adoc[]

=== `POST` : 행사의 함께 해요 목록에 게시글 추가

.HTTP request 설명
Expand Down Expand Up @@ -249,6 +238,17 @@ include::{snippets}/find-all-by-member-id-recruitment-post/http-response.adoc[]
.HTTP response 설명
include::{snippets}/find-all-by-member-id-recruitment-post/response-fields.adoc[]

=== `GET` : 행사 상세정보 조회

.HTTP request
include::{snippets}/find-event/http-request.adoc[]

.HTTP response
include::{snippets}/find-event/http-response.adoc[]

.HTTP response 설명
include::{snippets}/find-event/response-fields.adoc[]

=== `GET`: 행사 목록 조회

.HTTP request
Expand Down Expand Up @@ -285,44 +285,6 @@ include::{snippets}/find-recruitment-post/http-response.adoc[]
.HTTP response 설명
include::{snippets}/find-recruitment-post/response-fields.adoc[]

=== `POST` : 행사 생성

POST

.HTTP request
include::{snippets}/add-event/http-request.adoc[]

.HTTP request 설명
include::{snippets}/add-event/request-parts.adoc[]

.HTTP response
include::{snippets}/add-event/http-response.adoc[]

.HTTP response 설명
include::{snippets}/add-event/response-fields.adoc[]

=== `PUT` : 행사 업데이트

.HTTP request
include::{snippets}/update-event/http-request.adoc[]

.HTTP request 설명
include::{snippets}/update-event/request-parts.adoc[]

.HTTP response
include::{snippets}/update-event/http-response.adoc[]

.HTTP response 설명
include::{snippets}/update-event/response-fields.adoc[]

=== `DELETE` : 행사 삭제

.HTTP request
include::{snippets}/delete-event/http-request.adoc[]

.HTTP response
include::{snippets}/delete-event/http-response.adoc[]

== Comment

=== `GET` : 댓글 모두 조회
Expand Down Expand Up @@ -439,17 +401,6 @@ include::{snippets}/unregister-block/http-request.adoc[]
.HTTP response
include::{snippets}/unregister-block/http-response.adoc[]

=== `GET` : 차단한 사용자 목록 조회

.HTTP request
include::{snippets}/find-blocks/http-request.adoc[]

.HTTP response
include::{snippets}/find-blocks/http-response.adoc[]

.HTTP response 설명
include::{snippets}/find-blocks/response-fields.adoc[]

== TAG

=== `GET` : 존재하는 모든 태그 조회
Expand Down Expand Up @@ -706,3 +657,53 @@ include::{snippets}/delete-notifications/request-fields.adoc[]

.HTTP response
include::{snippets}/delete-notifications/http-response.adoc[]

== 관리자 API

=== `POST` : 행사 생성

.HTTP request
include::{snippets}/add-event/http-request.adoc[]

.HTTP request 설명
include::{snippets}/add-event/request-parts.adoc[]

.HTTP response
include::{snippets}/add-event/http-response.adoc[]

.HTTP response 설명
include::{snippets}/add-event/response-fields.adoc[]

=== `PUT` : 행사 업데이트

.HTTP request
include::{snippets}/update-event/http-request.adoc[]

.HTTP request 설명
include::{snippets}/update-event/request-parts.adoc[]

.HTTP response
include::{snippets}/update-event/http-response.adoc[]

.HTTP response 설명
include::{snippets}/update-event/response-fields.adoc[]

=== `DELETE` : 행사 삭제

.HTTP request
include::{snippets}/delete-event/http-request.adoc[]

.HTTP response
include::{snippets}/delete-event/http-response.adoc[]

=== `GET` : 차단한 사용자 목록 조회

.HTTP request
include::{snippets}/find-blocks/http-request.adoc[]

.HTTP response
include::{snippets}/find-blocks/http-response.adoc[]

.HTTP response 설명
include::{snippets}/find-blocks/response-fields.adoc[]

0 comments on commit 5a3d1a8

Please sign in to comment.