Notice
Recent Posts
Recent Comments
Link
일 | 월 | 화 | 수 | 목 | 금 | 토 |
---|---|---|---|---|---|---|
1 | 2 | 3 | 4 | |||
5 | 6 | 7 | 8 | 9 | 10 | 11 |
12 | 13 | 14 | 15 | 16 | 17 | 18 |
19 | 20 | 21 | 22 | 23 | 24 | 25 |
26 | 27 | 28 | 29 | 30 | 31 |
Tags
- @ConfigurationProperties
- Application Runner
- 백준
- 리소스 서버
- WebApplication Type
- 정적 리소스
- 스프링부트
- application.properties
- EnableAutoConfiguration
- webjar
- cors
- Application Event
- 백기선
- Application Argument
- 스프링 부트
- rest api
- Spring Security
- AuthenticationPrincipal
- 알고리즘
- JPA
- HttpMessageConverters
- OAuth2
- JsonSerializer
- @Profile
- 백트래킹
- 브루트포스
- HATEOAS
- 외부설정
- 다익스트라
- 리소스핸들러
Archives
- Today
- Total
아카이브
[스프링 기반 REST API 개발] Spring REST Docs 문서 빌드하기 본문
Mavn plugin 설정하기
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<version>1.5.8</version>
<executions>
<execution>
<id>generate-docs</id>
<phase>prepare-package</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
<configuration>
<backend>html</backend>
<doctype>book</doctype>
</configuration>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>org.springframework.restdocs</groupId>
<artifactId>spring-restdocs-asciidoctor</artifactId>
<version>${spring-restdocs.version}</version>
</dependency>
</dependencies>
</plugin>
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<executions>
<execution>
<id>copy-resources</id>
<phase>prepare-package</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<outputDirectory>
${project.build.outputDirectory}/static/docs
</outputDirectory>
<resources>
<resource>
<directory>
${project.build.directory}/generated-docs
</directory>
</resource>
</resources>
</configuration>
</execution>
</executions>
</plugin>
adoc template 추가 src/main/asciidoc/index.adoc
mvn package -> target/generated-docs, target/classes/static/docs 에 index.html 생성
'Spring > 스프링 기반 REST API 개발' 카테고리의 다른 글
[스프링 기반 REST API 개발] API Index Handler, ErrorsResource 추가하기 (0) | 2021.01.06 |
---|---|
[스프링 기반 REST API 개발] 테스트용 DB와 설정 분리하기 (0) | 2021.01.06 |
[스프링 기반 REST API 개발] Request/Response 필드와 헤더 문서화하기 (0) | 2021.01.06 |
[스프링 기반 REST API 개발] Spring REST Docs 소개, 자동 설정 및 커스터마이징 (0) | 2021.01.06 |
[스프링 기반 REST API 개발] Spring HATEOAS 적용 (0) | 2021.01.06 |