Skip to content
This repository was archived by the owner on Dec 19, 2023. It is now read-only.

Commit 4adcce0

Browse files
jmisurjmisur
authored
Renamed WebTestClient to WebFlux (#263)
1 parent 30b9ee1 commit 4adcce0

File tree

23 files changed

+69
-67
lines changed

23 files changed

+69
-67
lines changed

‎docs/index.html‎

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -535,12 +535,24 @@ <h2 id="faq"><a class="link" href="#faq">FAQ</a></h2>
535535
<div class="qlist qanda">
536536
<ol>
537537
<li>
538-
<p><em>Does it work with Spring MVC tests?</em></p>
539-
<p>Yes, it is easy to use in existing or new Spring MVC tests. Take a look at the example.</p>
538+
<p><em>Does it work with Spring Web MVC tests?</em></p>
539+
<p>Yes, take a look at the <a href="https://github.com/ScaCap/spring-auto-restdocs/tree/master/samples/java-webmvc">example</a>.</p>
540540
</li>
541541
<li>
542-
<p><em>Does it work with Spring WebTestClient?</em></p>
543-
<p>Yes, but only basic support yet. Take a look at the example.</p>
542+
<p><em>Does it work with Spring WebFlux?</em></p>
543+
<p>Yes, take a look at the <a href="https://github.com/ScaCap/spring-auto-restdocs/tree/master/samples/java-webflux">example</a>.</p>
544+
</li>
545+
<li>
546+
<p><em>Is Kotlin supported?</em></p>
547+
<p>Yes, Spring Auto REST Docs 1.0.13 and 2.0.0 introduced Kotlin support.
548+
Instead of the Javadoc Doclet one has to use the Dokka extension
549+
<code>spring-auto-restdocs-dokka-json</code>. The extension is only available as 2.0.x,
550+
but works with both version of Spring Auto REST Docs. Take a look at the
551+
<a href="https://github.com/ScaCap/spring-auto-restdocs/tree/master/samples/kotlin-webmvc">example</a>.</p>
552+
</li>
553+
<li>
554+
<p><em>Is Java 9 supported?</em></p>
555+
<p>Yes, see <a href="#getting-started">Getting Started</a>.</p>
544556
</li>
545557
<li>
546558
<p><em>Does it work with REST Assured tests?</em></p>
@@ -565,17 +577,6 @@ <h2 id="faq"><a class="link" href="#faq">FAQ</a></h2>
565577
One can generate Spring REST Docs snippets and Spring Auto REST Docs snippets out of the same test.
566578
This is demonstrated in the example project.</p>
567579
</li>
568-
<li>
569-
<p><em>Is Kotlin supported?</em></p>
570-
<p>Yes, Spring Auto REST Docs 1.0.13 and 2.0.0 introduced Kotlin support.
571-
Instead of the Javadoc Doclet one has to use the Dokka extension
572-
<code>spring-auto-restdocs-dokka-json</code>. The extension is only available as 2.0.x,
573-
but works with both version of Spring Auto REST Docs.</p>
574-
</li>
575-
<li>
576-
<p><em>Is Java 9 supported?</em></p>
577-
<p>Yes, see <a href="#getting-started">Getting Started</a>.</p>
578-
</li>
579580
</ol>
580581
</div>
581582
</div>
@@ -886,7 +887,7 @@ <h3 id="gettingstarted-sample"><a class="link" href="#gettingstarted-sample">Sam
886887
<p>This projects includes a
887888
<a href="https://github.com/ScaCap/spring-auto-restdocs/tree/master/samples/java-webmvc">Java Web MVC example</a>,
888889
a
889-
<a href="https://github.com/ScaCap/spring-auto-restdocs/tree/master/samples/java-webtestclient">Java WebTestClient example</a>
890+
<a href="https://github.com/ScaCap/spring-auto-restdocs/tree/master/samples/java-webflux">Java WebFlux example</a>
890891
and a
891892
<a href="https://github.com/ScaCap/spring-auto-restdocs/tree/master/samples/kotlin-webmvc">Kotlin Web MVC example</a>
892893
application that demonstrate most features.</p>
@@ -895,7 +896,7 @@ <h3 id="gettingstarted-sample"><a class="link" href="#gettingstarted-sample">Sam
895896
<p>The generated documentation can be viewed for the
896897
<a href="https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/master/samples/java-webmvc/generated-docs/index.html">Java Web MVC example</a>,
897898
the
898-
<a href="https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/master/samples/java-webtestclient/generated-docs/index.html">Java WebTestClient example</a>
899+
<a href="https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/master/samples/java-webflux/generated-docs/index.html">Java WebFlux example</a>
899900
and the
900901
<a href="https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/master/samples/kotlin-webmvc/generated-docs/index.html">Kotlin Web MCV example</a>.</p>
901902
</div>
@@ -1951,7 +1952,7 @@ <h4 id="contributing-building-build"><a class="link" href="#contributing-buildin
19511952
<div id="footer">
19521953
<div id="footer-text">
19531954
Version 2.0.2-SNAPSHOT<br>
1954-
Last updated 2018-09-20 10:03:44 CEST
1955+
Last updated 2018-09-20 10:38:11 CEST
19551956
</div>
19561957
</div>
19571958
<link rel="stylesheet" href="highlight/styles/github.min.css">

‎samples/java-webtestclient/README.md‎ renamed to ‎samples/java-webflux/README.md‎

File renamed without changes.

‎samples/java-webtestclient/generated-docs/index.html‎ renamed to ‎samples/java-webflux/generated-docs/index.html‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1949,13 +1949,13 @@ <h4 id="_example_response_5"><a class="anchor" href="#_example_response_5"></a><
19491949
} ],
19501950
"pageable" : "INSTANCE",
19511951
"total" : 1,
1952-
"totalPages" : 1,
19531952
"totalElements" : 1,
1953+
"totalPages" : 1,
19541954
"last" : true,
19551955
"size" : 0,
19561956
"number" : 0,
1957-
"numberOfElements" : 1,
19581957
"first" : true,
1958+
"numberOfElements" : 1,
19591959
"sort" : {
19601960
"orders" : [ ],
19611961
"sorted" : false,
@@ -2433,26 +2433,26 @@ <h3 id="resources-items-get-spring-rest-docs"><a class="anchor" href="#resources
24332433
<div class="sect3">
24342434
<h4 id="_authorization_12"><a class="anchor" href="#_authorization_12"></a><a class="link" href="#_authorization_12">2.12.1. Authorization</a></h4>
24352435
<div class="paragraph">
2436-
<p>Unresolved directive in srd-items.adoc - include::/Users/duro/dev/spring-auto-restdocs/samples/java-webtestclient/target/generated-snippets/item-resource-test/get-item-with-rest-docs/auto-authorization.adoc[]</p>
2436+
<p>Unresolved directive in srd-items.adoc - include::/Users/duro/dev/spring-auto-restdocs/samples/java-webflux/target/generated-snippets/item-resource-test/get-item-with-rest-docs/auto-authorization.adoc[]</p>
24372437
</div>
24382438
</div>
24392439
<div class="sect3">
24402440
<h4 id="_path_parameters_11"><a class="anchor" href="#_path_parameters_11"></a><a class="link" href="#_path_parameters_11">2.12.2. Path parameters</a></h4>
24412441
<div class="paragraph">
2442-
<p>Unresolved directive in srd-items.adoc - include::/Users/duro/dev/spring-auto-restdocs/samples/java-webtestclient/target/generated-snippets/item-resource-test/get-item-with-rest-docs/path-parameters.adoc[]</p>
2442+
<p>Unresolved directive in srd-items.adoc - include::/Users/duro/dev/spring-auto-restdocs/samples/java-webflux/target/generated-snippets/item-resource-test/get-item-with-rest-docs/path-parameters.adoc[]</p>
24432443
</div>
24442444
</div>
24452445
<div class="sect3">
24462446
<h4 id="_response_fields_12"><a class="anchor" href="#_response_fields_12"></a><a class="link" href="#_response_fields_12">2.12.3. Response fields</a></h4>
24472447
<div class="paragraph">
2448-
<p>Unresolved directive in srd-items.adoc - include::/Users/duro/dev/spring-auto-restdocs/samples/java-webtestclient/target/generated-snippets/item-resource-test/get-item-with-rest-docs/response-fields.adoc[]</p>
2448+
<p>Unresolved directive in srd-items.adoc - include::/Users/duro/dev/spring-auto-restdocs/samples/java-webflux/target/generated-snippets/item-resource-test/get-item-with-rest-docs/response-fields.adoc[]</p>
24492449
</div>
24502450
</div>
24512451
<div class="sect3">
24522452
<h4 id="_example_request_response_3"><a class="anchor" href="#_example_request_response_3"></a><a class="link" href="#_example_request_response_3">2.12.4. Example request/response</a></h4>
24532453
<div class="paragraph">
2454-
<p>Unresolved directive in srd-items.adoc - include::/Users/duro/dev/spring-auto-restdocs/samples/java-webtestclient/target/generated-snippets/item-resource-test/get-item-with-rest-docs/curl-request.adoc[]
2455-
Unresolved directive in srd-items.adoc - include::/Users/duro/dev/spring-auto-restdocs/samples/java-webtestclient/target/generated-snippets/item-resource-test/get-item-with-rest-docs/http-response.adoc[]</p>
2454+
<p>Unresolved directive in srd-items.adoc - include::/Users/duro/dev/spring-auto-restdocs/samples/java-webflux/target/generated-snippets/item-resource-test/get-item-with-rest-docs/curl-request.adoc[]
2455+
Unresolved directive in srd-items.adoc - include::/Users/duro/dev/spring-auto-restdocs/samples/java-webflux/target/generated-snippets/item-resource-test/get-item-with-rest-docs/http-response.adoc[]</p>
24562456
</div>
24572457
</div>
24582458
</div>

‎samples/java-webtestclient/pom.xml‎ renamed to ‎samples/java-webflux/pom.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@
1212
</parent>
1313

1414
<groupId>capital.scalable</groupId>
15-
<artifactId>spring-auto-restdocs-java-webtestclient-example</artifactId>
15+
<artifactId>spring-auto-restdocs-java-webflux-example</artifactId>
1616
<version>0.0.1-SNAPSHOT</version>
1717

18-
<name>Spring Auto REST Docs Java WebTestClient Example Project</name>
18+
<name>Spring Auto REST Docs Java WebFlux Example Project</name>
1919
<description>Example project for Spring Auto REST Docs</description>
2020
<url>https://github.com/scacap/spring-auto-restdocs</url>
2121

‎samples/java-webtestclient/src/main/asciidoc/index.adoc‎ renamed to ‎samples/java-webflux/src/main/asciidoc/index.adoc‎

File renamed without changes.

‎samples/java-webtestclient/src/main/asciidoc/items.adoc‎ renamed to ‎samples/java-webflux/src/main/asciidoc/items.adoc‎

File renamed without changes.

‎samples/java-webtestclient/src/main/asciidoc/srd-items.adoc‎ renamed to ‎samples/java-webflux/src/main/asciidoc/srd-items.adoc‎

File renamed without changes.

‎samples/java-webtestclient/src/main/java/capital/scalable/restdocs/example/Application.java‎ renamed to ‎samples/java-webflux/src/main/java/capital/scalable/restdocs/example/Application.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/*-
22
* #%L
3-
* Spring Auto REST Docs Java WebTestClient Example Project
3+
* Spring Auto REST Docs Java WebFlux Example Project
44
* %%
55
* Copyright (C) 2015 - 2018 Scalable Capital GmbH
66
* %%

‎samples/java-webtestclient/src/main/java/capital/scalable/restdocs/example/items/ItemResource.java‎ renamed to ‎samples/java-webflux/src/main/java/capital/scalable/restdocs/example/items/ItemResource.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/*-
22
* #%L
3-
* Spring Auto REST Docs Java WebTestClient Example Project
3+
* Spring Auto REST Docs Java WebFlux Example Project
44
* %%
55
* Copyright (C) 2015 - 2018 Scalable Capital GmbH
66
* %%

‎samples/java-webtestclient/src/main/java/capital/scalable/restdocs/example/items/ItemResponse.java‎ renamed to ‎samples/java-webflux/src/main/java/capital/scalable/restdocs/example/items/ItemResponse.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/*-
22
* #%L
3-
* Spring Auto REST Docs Java WebTestClient Example Project
3+
* Spring Auto REST Docs Java WebFlux Example Project
44
* %%
55
* Copyright (C) 2015 - 2018 Scalable Capital GmbH
66
* %%

0 commit comments

Comments
 (0)