다음과 같이 User, Post 같이 여러 API들이 한 index.adoc 파일에 존재한다면 파일이 엄청 길어질 수 있어 분리하고
include 하여 사용할 수 있다.
- 먼저 분리할 목차에 마우스 커서를 올리고 맥 기준 option + enter를 누르면 다음과 같은 창이 나온다
- Extract Include Directive를 클릭하면 인텔리제이가 해당 문서를 분리해준다.
- src/docs/asciidoc 위치로 해당 API를 빼주게 된다.
- 사용할 곳에서 include::filename.adoc[] 을 이용하면 된다.
as-is
.... 위에 더 많이 존재
==== request-fail - 존재하지 않는 게시글
include::{snippets}/posts-findAll-NotFound/http-response.adoc[]
include::{snippets}/posts-findAll-NotFound/response-fields.adoc[]
== Common
=== ErrorResponseFormat
include::{snippets}/posts-update-all-FailEmptyValue/http-response.adoc[]
include::{snippets}/posts-update-all-FailEmptyValue/response-fields.adoc[]to-be
==== request-fail - 존재하지 않는 게시글
include::{snippets}/posts-findAll-NotFound/http-response.adoc[]
include::{snippets}/posts-findAll-NotFound/response-fields.adoc[]
include::common.adoc[] // << 분리된 common.adoc
== Common
=== ErrorResponseFormat
include::{snippets}/posts-update-all-FailEmptyValue/http-response.adoc[]
include::{snippets}/posts-update-all-FailEmptyValue/response-fields.adoc[]'Spring > RestDocs' 카테고리의 다른 글
| Restdocs pretty print, header 제거 (0) | 2023.01.29 |
|---|---|
| RestDocs Custom - 문서 커스텀 (1) | 2023.01.29 |
| Restdocs Enum 공통코드 문서화 방법 - Enum 문서화 (0) | 2023.01.29 |
| RestDocs에서 Snippet 파일명 커스텀, Restdocs Link(링크) 걸기 (1) | 2023.01.29 |
| IntelliJ Restdocs Unexpected token - .snippet 파일을 AsciiDoc로 인식하지 않을 때 (0) | 2023.01.28 |