437
437
< h1 > Spring Auto REST Docs</ h1 >
438
438
< div class ="details ">
439
439
< 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 >
441
441
</ div >
442
442
< div id ="toc " class ="toc2 ">
443
443
< div id ="toctitle "> Table of Contents</ div >
@@ -496,6 +496,7 @@ <h1>Spring Auto REST Docs</h1>
496
496
</ li >
497
497
< li > < a href ="#contributing "> Contributing</ a >
498
498
< ul class ="sectlevel2 ">
499
+ < li > < a href ="#contributing-pr "> Pull Requests</ a > </ li >
499
500
< li > < a href ="#contributing-building "> Building from source</ a > </ li >
500
501
</ ul >
501
502
</ li >
@@ -605,6 +606,10 @@ <h2 id="faq"><a class="link" href="#faq">FAQ</a></h2>
605
606
< p > < em > Is HATEOAS supported?</ em > </ p >
606
607
< p > Yes, there is basic support for < a href ="#snippets-links "> links</ a > and < a href ="#snippets-embedded "> embedded</ a > resources.</ p >
607
608
</ 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 >
608
613
</ ol >
609
614
</ div >
610
615
</ div >
@@ -620,7 +625,7 @@ <h3 id="gettingstarted-requirements"><a class="link" href="#gettingstarted-requi
620
625
< div class ="ulist ">
621
626
< ul >
622
627
< li >
623
- < p > Java 8 or Kotlin 1.2 </ p >
628
+ < p > Java 8 or Kotlin 1.3 </ p >
624
629
</ li >
625
630
< li >
626
631
< 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
635
640
please use the 1.0.x version of Spring Auto REST Docs.</ p >
636
641
</ div >
637
642
< 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 >
639
646
</ div >
640
647
</ div >
641
648
< div class ="sect2 ">
@@ -653,7 +660,7 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">Usage
653
660
< pre class ="highlightjs highlight "> < code class ="language-xml hljs " data-lang ="xml "> <dependency>
654
661
<groupId>capital.scalable</groupId>
655
662
<artifactId>spring-auto-restdocs-core</artifactId>
656
- <version>2.0.8 </version>
663
+ <version>2.0.9 </version>
657
664
<scope>test</scope>
658
665
</dependency>
659
666
@@ -690,7 +697,7 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">Usage
690
697
<docletArtifact>
691
698
<groupId>capital.scalable</groupId>
692
699
<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>
694
701
</docletArtifact>
695
702
<destDir>generated-javadoc-json</destDir> < i class ="conum " data-value ="2 "> </ i > < b > (2)</ b >
696
703
<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
735
742
}
736
743
737
744
dependencies {
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 >
740
747
}
741
748
742
749
task jsonDoclet(type: Javadoc, dependsOn: compileJava) {
@@ -1366,7 +1373,9 @@ <h3 id="snippets-section"><a class="link" href="#snippets-section">Section snipp
1366
1373
1367
1374
==== {{header}}
1368
1375
1369
- include::{{fileName}}.adoc[]
1376
+ {{#filenames}}
1377
+ include::{{.}}.adoc[]
1378
+ {{/filenames}}
1370
1379
{{/sections}}</ code > </ pre >
1371
1380
</ div >
1372
1381
</ div >
@@ -1795,7 +1804,9 @@ <h3 id="snippets-section"><a class="link" href="#snippets-section">Section snipp
1795
1804
1796
1805
==== {{header}}
1797
1806
1798
- include::{{fileName}}.adoc[]
1807
+ {{#filenames}}
1808
+ include::{{.}}.adoc[]
1809
+ {{/filenames}}
1799
1810
{{/sections}}</ code > </ pre >
1800
1811
</ div >
1801
1812
</ div >
@@ -2436,13 +2447,19 @@ <h3 id="integrations-wiremock"><a class="link" href="#integrations-wiremock">Wir
2436
2447
< h2 id ="contributing "> < a class ="link " href ="#contributing "> Contributing</ a > </ h2 >
2437
2448
< div class ="sectionbody ">
2438
2449
< 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 ">
2439
2456
< h3 id ="contributing-building "> < a class ="link " href ="#contributing-building "> Building from source</ a > </ h3 >
2440
2457
< 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 >
2442
2459
< div class ="paragraph ">
2443
2460
< p > The Spring REST Docs test JAR is not published via Maven, but this project relies on it.
2444
2461
If 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 >
2446
2463
</ div >
2447
2464
< div class ="listingblock ">
2448
2465
< div class ="title "> Bash</ div >
@@ -2454,7 +2471,23 @@ <h4 id="contributing-installing-testjar"><a class="link" href="#contributing-ins
2454
2471
</ div >
2455
2472
</ div >
2456
2473
< 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 >
2458
2491
< div class ="paragraph ">
2459
2492
< p > Building the Spring REST Docs test JAR is not required to build the project,
2460
2493
but 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
2497
2530
</ div >
2498
2531
</ div >
2499
2532
< 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
[email protected] :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 ">
2500
2583
< h4 id ="contributing-building-build "> < a class ="link " href ="#contributing-building-build "> Build</ a > </ h4 >
2501
2584
< div class ="listingblock ">
2502
2585
< div class ="title "> Bash (in root folder)</ div >
@@ -2511,8 +2594,8 @@ <h4 id="contributing-building-build"><a class="link" href="#contributing-buildin
2511
2594
</ div >
2512
2595
< div id ="footer ">
2513
2596
< 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
2516
2599
</ div >
2517
2600
</ div >
2518
2601
< link rel ="stylesheet " href ="highlight/styles/github.min.css ">
0 commit comments