iSharkFly-Docs
/
java-tutorials
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

BAEL-6131: Moving REST Docs to a separate package (#16273) 

* BAEL-6131:  Moving REST Docs to a separate package

* BAEL-6131:  Removed askii-doctor configurations
This commit is contained in:
Eugene Kovko 2024-04-08 18:17:38 +02:00 committed by GitHub
parent 4b5e5192d9
commit 930f1ce0a5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
19 changed files with 138 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
spring-5-rest-docs/.gitignore vendored Normal file
View File

@ -0,0 +1,12 @@
#folders#
.idea
/target
/neoDb*
/data
/src/main/webapp/WEB-INF/classes
*/META-INF/*
# Packaged files #
*.jar
*.war
*.ear

8
spring-5-rest-docs/README.md Normal file
View File

@ -0,0 +1,8 @@
## Spring 5 REST Docs
This module contains articles about Spring 5
### Relevant Articles
- [Introduction to Spring REST Docs](https://www.baeldung.com/spring-rest-docs)
- [Document Query Parameters with Spring REST Docs](https://www.baeldung.com/spring-rest-document-query-parameters)

118
spring-5-rest-docs/pom.xml Normal file
View File

@ -0,0 +1,118 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<artifactId>spring-5</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>spring-5</name>
<packaging>jar</packaging>
<description>spring 5 sample project about new features</description>
<parent>
<groupId>com.baeldung</groupId>
<artifactId>parent-boot-3</artifactId>
<version>0.0.1-SNAPSHOT</version>
<relativePath>../parent-boot-3</relativePath>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-security</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-hateoas</artifactId>
</dependency>
<dependency>
<groupId>com.h2database</groupId>
<artifactId>h2</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-test</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.security</groupId>
<artifactId>spring-security-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-api</artifactId>
</dependency>
<!-- restdocs -->
<dependency>
<groupId>org.springframework.restdocs</groupId>
<artifactId>spring-restdocs-mockmvc</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.restdocs</groupId>
<artifactId>spring-restdocs-restassured</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.restdocs</groupId>
<artifactId>spring-restdocs-webtestclient</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<mainClass>com.baeldung.Spring5Application</mainClass>
<layout>JAR</layout>
</configuration>
</plugin>
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<version>${asciidoctor-plugin.version}</version>
<executions>
<execution>
<id>generate-docs</id>
<phase>package</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
<configuration>
<backend>html</backend>
<doctype>book</doctype>
<attributes>
<snippets>${snippetsDirectory}</snippets>
</attributes>
<sourceDirectory>src/docs/asciidocs</sourceDirectory>
<outputDirectory>target/generated-docs</outputDirectory>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
<properties>
<asciidoctor-plugin.version>2.2.6</asciidoctor-plugin.version>
<snippetsDirectory>${project.build.directory}/generated-snippets</snippetsDirectory>
<spring-boot.repackage.skip>true</spring-boot.repackage.skip>
</properties>
</project>

0
spring-5/src/docs/asciidocs/api-guide.adoc → spring-5-rest-docs/src/docs/asciidocs/api-guide.adoc
View File

0
spring-5/src/main/java/com/baeldung/queryparamdoc/Application.java → spring-5-rest-docs/src/main/java/com/baeldung/queryparamdoc/Application.java
View File

0
spring-5/src/main/java/com/baeldung/queryparamdoc/Book.java → spring-5-rest-docs/src/main/java/com/baeldung/queryparamdoc/Book.java
View File

0
spring-5/src/main/java/com/baeldung/queryparamdoc/BookController.java → spring-5-rest-docs/src/main/java/com/baeldung/queryparamdoc/BookController.java
View File

0
spring-5/src/main/java/com/baeldung/queryparamdoc/BookService.java → spring-5-rest-docs/src/main/java/com/baeldung/queryparamdoc/BookService.java
View File

0
spring-5/src/main/java/com/baeldung/restdocs/CRUDController.java → spring-5-rest-docs/src/main/java/com/baeldung/restdocs/CRUDController.java
View File

0
spring-5/src/main/java/com/baeldung/restdocs/CrudInput.java → spring-5-rest-docs/src/main/java/com/baeldung/restdocs/CrudInput.java
View File

0
spring-5/src/main/java/com/baeldung/restdocs/IndexController.java → spring-5-rest-docs/src/main/java/com/baeldung/restdocs/IndexController.java
View File

0
spring-5/src/main/java/com/baeldung/restdocs/SpringRestDocsApplication.java → spring-5-rest-docs/src/main/java/com/baeldung/restdocs/SpringRestDocsApplication.java
View File

0
spring-5/src/test/java/com/baeldung/queryparamdoc/BookControllerMvcIntegrationTest.java → spring-5-rest-docs/src/test/java/com/baeldung/queryparamdoc/BookControllerMvcIntegrationTest.java
View File

0
spring-5/src/test/java/com/baeldung/queryparamdoc/BookControllerReactiveIntegrationTest.java → spring-5-rest-docs/src/test/java/com/baeldung/queryparamdoc/BookControllerReactiveIntegrationTest.java
View File

0
spring-5/src/test/java/com/baeldung/queryparamdoc/BookControllerRestAssuredIntegrationTest.java → spring-5-rest-docs/src/test/java/com/baeldung/queryparamdoc/BookControllerRestAssuredIntegrationTest.java
View File

0
spring-5/src/test/java/com/baeldung/restdocs/ApiDocumentationJUnit4IntegrationTest.java → spring-5-rest-docs/src/test/java/com/baeldung/restdocs/ApiDocumentationJUnit4IntegrationTest.java
View File

0
spring-5/src/test/java/com/baeldung/restdocs/ApiDocumentationJUnit5IntegrationTest.java → spring-5-rest-docs/src/test/java/com/baeldung/restdocs/ApiDocumentationJUnit5IntegrationTest.java
View File

2
spring-5/README.md
View File

@ -6,9 +6,7 @@ This module contains articles about Spring 5
- [Spring 5 Functional Bean Registration](https://www.baeldung.com/spring-5-functional-beans)
- [The SpringJUnitConfig and SpringJUnitWebConfig Annotations in Spring 5](https://www.baeldung.com/spring-5-junit-config)
- [Introduction to Spring REST Docs](https://www.baeldung.com/spring-rest-docs)
- [Spring ResponseStatusException](https://www.baeldung.com/spring-response-status-exception)
- [Spring Assert Statements](https://www.baeldung.com/spring-assert)
- [Difference between context:annotation-config vs context:component-scan](https://www.baeldung.com/spring-contextannotation-contextcomponentscan)
- [Configuring a Hikari Connection Pool with Spring Boot](https://www.baeldung.com/spring-boot-hikari)
- [Document Query Parameters with Spring REST Docs](https://www.baeldung.com/spring-rest-document-query-parameters)

25
spring-5/pom.xml
View File

@ -131,36 +131,11 @@
<layout>JAR</layout>
</configuration>
</plugin>
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<version>${asciidoctor-plugin.version}</version>
<executions>
<execution>
<id>generate-docs</id>
<phase>package</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
<configuration>
<backend>html</backend>
<doctype>book</doctype>
<attributes>
<snippets>${snippetsDirectory}</snippets>
</attributes>
<sourceDirectory>src/docs/asciidocs</sourceDirectory>
<outputDirectory>target/generated-docs</outputDirectory>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
<properties>
<geronimo-json_1.1_spec.version>1.0</geronimo-json_1.1_spec.version>
<asciidoctor-plugin.version>2.2.6</asciidoctor-plugin.version>
<snippetsDirectory>${project.build.directory}/generated-snippets</snippetsDirectory>
<hikaricp.version>5.1.0</hikaricp.version>
<spring-boot.repackage.skip>true</spring-boot.repackage.skip>
<jakarta.json-api.version>2.0.1</jakarta.json-api.version>