437437< h1 > Spring Auto REST Docs</ h1 >
438438< div class ="details ">
439439< span id ="author " class ="author "> Scalable Capital</ span > < br >
440- < span id ="revnumber "> version 2.0.9-SNAPSHOT </ span >
440+ < span id ="revnumber "> version 2.0.9</ span >
441441</ div >
442442< div id ="toc " class ="toc2 ">
443443< div id ="toctitle "> Table of Contents</ div >
@@ -496,6 +496,7 @@ <h1>Spring Auto REST Docs</h1>
496496</ li >
497497< li > < a href ="#contributing "> Contributing</ a >
498498< ul class ="sectlevel2 ">
499+ < li > < a href ="#contributing-pr "> Pull Requests</ a > </ li >
499500< li > < a href ="#contributing-building "> Building from source</ a > </ li >
500501</ ul >
501502</ li >
@@ -605,6 +606,10 @@ <h2 id="faq"><a class="link" href="#faq">FAQ</a></h2>
605606< p > < em > Is HATEOAS supported?</ em > </ p >
606607< p > Yes, there is basic support for < a href ="#snippets-links "> links</ a > and < a href ="#snippets-embedded "> embedded</ a > resources.</ p >
607608</ li >
609+ < li >
610+ < p > < em > What should I do if I get a < code > NoSuchBeanDefinitionException: No bean named 'webHandler' available</ code > exception?</ em > </ p >
611+ < p > This means that the servlet stack instead if the reactive one is active. Make sure that < code > @EnableWebFlux</ code > is used.</ p >
612+ </ li >
608613</ ol >
609614</ div >
610615</ div >
@@ -620,7 +625,7 @@ <h3 id="gettingstarted-requirements"><a class="link" href="#gettingstarted-requi
620625< div class ="ulist ">
621626< ul >
622627< li >
623- < p > Java 8 or Kotlin 1.2 </ p >
628+ < p > Java 8 or Kotlin 1.3 </ p >
624629</ li >
625630< li >
626631< p > Spring REST Docs 2.0.4.RELEASE (see < a href ="http://docs.spring.io/spring-restdocs/docs/2.0.4.RELEASE/reference/html5/ "> documentation</ a > )</ p >
@@ -635,7 +640,9 @@ <h3 id="gettingstarted-requirements"><a class="link" href="#gettingstarted-requi
635640please use the 1.0.x version of Spring Auto REST Docs.</ p >
636641</ div >
637642< div class ="paragraph ">
638- < p > For Java 9/10/11 support, use < code > spring-auto-restdocs-json-doclet-jdk9</ code > as doclet dependency.</ p >
643+ < p > For Java 9+ support, use < code > spring-auto-restdocs-json-doclet-jdk9</ code > as doclet dependency.
644+ Our support is focused on the latest Kotlin version, Java 8 and 11.
645+ In addition, we try to support the latest Java version that is supported by Spring.</ p >
639646</ div >
640647</ div >
641648< div class ="sect2 ">
@@ -653,7 +660,7 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">Usage
653660< pre class ="highlightjs highlight "> < code class ="language-xml hljs " data-lang ="xml "> <dependency>
654661 <groupId>capital.scalable</groupId>
655662 <artifactId>spring-auto-restdocs-core</artifactId>
656- <version>2.0.8 </version>
663+ <version>2.0.9 </version>
657664 <scope>test</scope>
658665</dependency>
659666
@@ -690,7 +697,7 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">Usage
690697 <docletArtifact>
691698 <groupId>capital.scalable</groupId>
692699 <artifactId>spring-auto-restdocs-json-doclet</artifactId> < i class ="conum " data-value ="3 "> </ i > < b > (3)</ b >
693- <version>2.0.8 </version>
700+ <version>2.0.9 </version>
694701 </docletArtifact>
695702 <destDir>generated-javadoc-json</destDir> < i class ="conum " data-value ="2 "> </ i > < b > (2)</ b >
696703 <reportOutputDirectory>${project.build.directory}</reportOutputDirectory> < i class ="conum " data-value ="2 "> </ i > < b > (2)</ b >
@@ -735,8 +742,8 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">Usage
735742}
736743
737744dependencies {
738- testCompile group: 'capital.scalable', name: 'spring-auto-restdocs-core', version: '2.0.8 '
739- jsondoclet group: 'capital.scalable', name: 'spring-auto-restdocs-json-doclet', version: '2.0.8 ' < i class ="conum " data-value ="3 "> </ i > < b > (3)</ b >
745+ testCompile group: 'capital.scalable', name: 'spring-auto-restdocs-core', version: '2.0.9 '
746+ jsondoclet group: 'capital.scalable', name: 'spring-auto-restdocs-json-doclet', version: '2.0.9 ' < i class ="conum " data-value ="3 "> </ i > < b > (3)</ b >
740747}
741748
742749task jsonDoclet(type: Javadoc, dependsOn: compileJava) {
@@ -1366,7 +1373,9 @@ <h3 id="snippets-section"><a class="link" href="#snippets-section">Section snipp
13661373
13671374==== {{header}}
13681375
1369- include::{{fileName}}.adoc[]
1376+ {{#filenames}}
1377+ include::{{.}}.adoc[]
1378+ {{/filenames}}
13701379{{/sections}}</ code > </ pre >
13711380</ div >
13721381</ div >
@@ -1795,7 +1804,9 @@ <h3 id="snippets-section"><a class="link" href="#snippets-section">Section snipp
17951804
17961805==== {{header}}
17971806
1798- include::{{fileName}}.adoc[]
1807+ {{#filenames}}
1808+ include::{{.}}.adoc[]
1809+ {{/filenames}}
17991810{{/sections}}</ code > </ pre >
18001811</ div >
18011812</ div >
@@ -2436,13 +2447,19 @@ <h3 id="integrations-wiremock"><a class="link" href="#integrations-wiremock">Wir
24362447< h2 id ="contributing "> < a class ="link " href ="#contributing "> Contributing</ a > </ h2 >
24372448< div class ="sectionbody ">
24382449< div class ="sect2 ">
2450+ < h3 id ="contributing-pr "> < a class ="link " href ="#contributing-pr "> Pull Requests</ a > </ h3 >
2451+ < div class ="paragraph ">
2452+ < p > For code formatting please use < a href ="https://github.com/ScaCap/spring-auto-restdocs/blob/master/intellij-codestyle.xml "> intellij-codestyle.xml</ a > .</ p >
2453+ </ div >
2454+ </ div >
2455+ < div class ="sect2 ">
24392456< h3 id ="contributing-building "> < a class ="link " href ="#contributing-building "> Building from source</ a > </ h3 >
24402457< div class ="sect3 ">
2441- < h4 id ="contributing-installing-testjar "> < a class ="link " href ="#contributing-installing-testjar "> Install Spring REST Docs test JAR</ a > </ h4 >
2458+ < h4 id ="contributing-installing-restdocs- testjar "> < a class ="link " href ="#contributing-installing-restdocs -testjar "> Install Spring REST Docs test JAR</ a > </ h4 >
24422459< div class ="paragraph ">
24432460< p > The Spring REST Docs test JAR is not published via Maven, but this project relies on it.
24442461If you want to build this project yourself, you need to install the test JAR.
2445- The test JAR is located in the lib folder and can be installed as follow :</ p >
2462+ The test JAR is located in the lib folder and can be installed as follows :</ p >
24462463</ div >
24472464< div class ="listingblock ">
24482465< div class ="title "> Bash</ div >
@@ -2454,7 +2471,23 @@ <h4 id="contributing-installing-testjar"><a class="link" href="#contributing-ins
24542471</ div >
24552472</ div >
24562473< div class ="sect3 ">
2457- < h4 id ="contributing-building-testjar "> < a class ="link " href ="#contributing-building-testjar "> Build Spring REST Docs test JAR</ a > </ h4 >
2474+ < h4 id ="contributing-installing-dokka-testjar "> < a class ="link " href ="#contributing-installing-dokka-testjar "> Install Dokka Core test JAR</ a > </ h4 >
2475+ < div class ="paragraph ">
2476+ < p > Dokka publishes no test JAR, but the Spring Auto REST Docs Dokka extension uses their test utilities.
2477+ If you want to build this project yourself, you need to install the test JAR.
2478+ The test JAR is located in the lib folder and can be installed as follows:</ p >
2479+ </ div >
2480+ < div class ="listingblock ">
2481+ < div class ="title "> Bash</ div >
2482+ < div class ="content ">
2483+ < pre class ="highlightjs highlight "> < code class ="language-bash hljs " data-lang ="bash "> mvn install:install-file -Dfile=lib/dokka-core-0.10.1-tests.jar \
2484+ -DgroupId=org.jetbrains.dokka -DartifactId=dokka-core -Dversion=0.10.1 \
2485+ -Dpackaging=jar -Dclassifier=test</ code > </ pre >
2486+ </ div >
2487+ </ div >
2488+ </ div >
2489+ < div class ="sect3 ">
2490+ < h4 id ="contributing-building-restdocs-testjar "> < a class ="link " href ="#contributing-building-restdocs-testjar "> Build Spring REST Docs test JAR</ a > </ h4 >
24582491< div class ="paragraph ">
24592492< p > Building the Spring REST Docs test JAR is not required to build the project,
24602493but if you ever want to upgrade the version of Spring REST Docs in this project this step has to be done.</ p >
@@ -2497,6 +2530,56 @@ <h4 id="contributing-building-testjar"><a class="link" href="#contributing-build
24972530</ div >
24982531</ div >
24992532< div class ="sect3 ">
2533+ < h4 id ="contributing-building-dokka-testjar "> < a class ="link " href ="#contributing-building-dokka-testjar "> Build Dokka Core test JAR</ a > </ h4 >
2534+ < div class ="paragraph ">
2535+ < p > Building the Dokka core test JAR is not required to build the project,
2536+ but if you ever want to upgrade the version of Dokka in this project this step has to be done.</ p >
2537+ </ div >
2538+ < div class ="paragraph ">
2539+ < p > We use version 0.10.1 of Dokka in this example.</ p >
2540+ </ div >
2541+ < div class ="paragraph ">
2542+ < p > Clone and checkout a specific version of Dokka:</ p >
2543+ </ div >
2544+ < div class ="listingblock ">
2545+ < div class ="title "> Bash</ div >
2546+ < div class ="content ">
2547+ < pre class ="highlightjs highlight "> < code class ="language-bash hljs " data-lang ="bash "> git clone git@github.com:Kotlin/dokka.git
2548+ cd dokka
2549+ git checkout 0.10.1</ code > </ pre >
2550+ </ div >
2551+ </ div >
2552+ < div class ="paragraph ">
2553+ < p > Add the following snippet at the end of < code > core/build.gradle</ code > :</ p >
2554+ </ div >
2555+ < div class ="listingblock ">
2556+ < div class ="content ">
2557+ < pre class ="highlightjs highlight "> < code class ="language-groovy hljs " data-lang ="groovy "> task testJar(type: Jar) {
2558+ classifier = 'tests'
2559+ from sourceSets.test.output
2560+ }</ code > </ pre >
2561+ </ div >
2562+ </ div >
2563+ < div class ="paragraph ">
2564+ < p > To speed the build up and avoid test issues, once can reduce the list of sub-projects in
2565+ < code > settings.gradle</ code > to just < code > core</ code > and < code > integration</ code > .</ p >
2566+ </ div >
2567+ < div class ="paragraph ">
2568+ < p > Make sure to use JDK 8 for the build.
2569+ Create the test JAR by running the following command on the top-level:</ p >
2570+ </ div >
2571+ < div class ="listingblock ">
2572+ < div class ="title "> Bash</ div >
2573+ < div class ="content ">
2574+ < pre class ="highlightjs highlight "> < code class ="language-bash hljs " data-lang ="bash "> ./gradlew testJar</ code > </ pre >
2575+ </ div >
2576+ </ div >
2577+ < div class ="paragraph ">
2578+ < p > Afterwards the test JAR is located at
2579+ < code > core/build/libs/core-0.10.1-SNAPSHOT-tests.jar</ code > </ p >
2580+ </ div >
2581+ </ div >
2582+ < div class ="sect3 ">
25002583< h4 id ="contributing-building-build "> < a class ="link " href ="#contributing-building-build "> Build</ a > </ h4 >
25012584< div class ="listingblock ">
25022585< div class ="title "> Bash (in root folder)</ div >
@@ -2511,8 +2594,8 @@ <h4 id="contributing-building-build"><a class="link" href="#contributing-buildin
25112594</ div >
25122595< div id ="footer ">
25132596< div id ="footer-text ">
2514- Version 2.0.9-SNAPSHOT < br >
2515- Last updated 2020-03-29 23:43:30 +0200
2597+ Version 2.0.9< br >
2598+ Last updated 2020-08-10 10:13:23 +0200
25162599</ div >
25172600</ div >
25182601< link rel ="stylesheet " href ="highlight/styles/github.min.css ">
0 commit comments