diff --git a/docs/index.html b/docs/index.html index de74bd46..2425abf3 100644 --- a/docs/index.html +++ b/docs/index.html @@ -535,12 +535,24 @@

FAQ

  1. -

    Does it work with Spring MVC tests?

    -

    Yes, it is easy to use in existing or new Spring MVC tests. Take a look at the example.

    +

    Does it work with Spring Web MVC tests?

    +

    Yes, take a look at the example.

  2. -

    Does it work with Spring WebTestClient?

    -

    Yes, but only basic support yet. Take a look at the example.

    +

    Does it work with Spring WebFlux?

    +

    Yes, take a look at the example.

    +
  3. +
  4. +

    Is Kotlin supported?

    +

    Yes, Spring Auto REST Docs 1.0.13 and 2.0.0 introduced Kotlin support. +Instead of the Javadoc Doclet one has to use the Dokka extension +spring-auto-restdocs-dokka-json. The extension is only available as 2.0.x, +but works with both version of Spring Auto REST Docs. Take a look at the +example.

    +
  5. +
  6. +

    Is Java 9 supported?

    +

    Yes, see Getting Started.

  7. Does it work with REST Assured tests?

    @@ -565,17 +577,6 @@

    FAQ

    One can generate Spring REST Docs snippets and Spring Auto REST Docs snippets out of the same test. This is demonstrated in the example project.

  8. -
  9. -

    Is Kotlin supported?

    -

    Yes, Spring Auto REST Docs 1.0.13 and 2.0.0 introduced Kotlin support. -Instead of the Javadoc Doclet one has to use the Dokka extension -spring-auto-restdocs-dokka-json. The extension is only available as 2.0.x, -but works with both version of Spring Auto REST Docs.

    -
  10. -
  11. -

    Is Java 9 supported?

    -

    Yes, see Getting Started.

    -
@@ -886,7 +887,7 @@

Sam

This projects includes a Java Web MVC example, a -Java WebTestClient example +Java WebFlux example and a Kotlin Web MVC example application that demonstrate most features.

@@ -895,7 +896,7 @@

Sam

The generated documentation can be viewed for the Java Web MVC example, the -Java WebTestClient example +Java WebFlux example and the Kotlin Web MCV example.

@@ -1951,7 +1952,7 @@

diff --git a/samples/java-webtestclient/README.md b/samples/java-webflux/README.md similarity index 100% rename from samples/java-webtestclient/README.md rename to samples/java-webflux/README.md diff --git a/samples/java-webtestclient/generated-docs/index.html b/samples/java-webflux/generated-docs/index.html similarity index 99% rename from samples/java-webtestclient/generated-docs/index.html rename to samples/java-webflux/generated-docs/index.html index f565f534..5c63d3bb 100644 --- a/samples/java-webtestclient/generated-docs/index.html +++ b/samples/java-webflux/generated-docs/index.html @@ -1949,13 +1949,13 @@

< } ], "pageable" : "INSTANCE", "total" : 1, - "totalPages" : 1, "totalElements" : 1, + "totalPages" : 1, "last" : true, "size" : 0, "number" : 0, - "numberOfElements" : 1, "first" : true, + "numberOfElements" : 1, "sort" : { "orders" : [ ], "sorted" : false, @@ -2433,26 +2433,26 @@

2.12.1. Authorization

-

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[]

+

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[]

2.12.2. Path parameters

-

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[]

+

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[]

2.12.3. Response fields

-

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[]

+

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[]

2.12.4. Example request/response

-

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[] -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[]

+

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[] +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[]

diff --git a/samples/java-webtestclient/pom.xml b/samples/java-webflux/pom.xml similarity index 98% rename from samples/java-webtestclient/pom.xml rename to samples/java-webflux/pom.xml index 09962b1c..c56f52e2 100644 --- a/samples/java-webtestclient/pom.xml +++ b/samples/java-webflux/pom.xml @@ -12,10 +12,10 @@ capital.scalable - spring-auto-restdocs-java-webtestclient-example + spring-auto-restdocs-java-webflux-example 0.0.1-SNAPSHOT - Spring Auto REST Docs Java WebTestClient Example Project + Spring Auto REST Docs Java WebFlux Example Project Example project for Spring Auto REST Docs https://github.com/scacap/spring-auto-restdocs diff --git a/samples/java-webtestclient/src/main/asciidoc/index.adoc b/samples/java-webflux/src/main/asciidoc/index.adoc similarity index 100% rename from samples/java-webtestclient/src/main/asciidoc/index.adoc rename to samples/java-webflux/src/main/asciidoc/index.adoc diff --git a/samples/java-webtestclient/src/main/asciidoc/items.adoc b/samples/java-webflux/src/main/asciidoc/items.adoc similarity index 100% rename from samples/java-webtestclient/src/main/asciidoc/items.adoc rename to samples/java-webflux/src/main/asciidoc/items.adoc diff --git a/samples/java-webtestclient/src/main/asciidoc/srd-items.adoc b/samples/java-webflux/src/main/asciidoc/srd-items.adoc similarity index 100% rename from samples/java-webtestclient/src/main/asciidoc/srd-items.adoc rename to samples/java-webflux/src/main/asciidoc/srd-items.adoc diff --git a/samples/java-webtestclient/src/main/java/capital/scalable/restdocs/example/Application.java b/samples/java-webflux/src/main/java/capital/scalable/restdocs/example/Application.java similarity index 94% rename from samples/java-webtestclient/src/main/java/capital/scalable/restdocs/example/Application.java rename to samples/java-webflux/src/main/java/capital/scalable/restdocs/example/Application.java index af3be308..47718e7e 100644 --- a/samples/java-webtestclient/src/main/java/capital/scalable/restdocs/example/Application.java +++ b/samples/java-webflux/src/main/java/capital/scalable/restdocs/example/Application.java @@ -1,6 +1,6 @@ /*- * #%L - * Spring Auto REST Docs Java WebTestClient Example Project + * Spring Auto REST Docs Java WebFlux Example Project * %% * Copyright (C) 2015 - 2018 Scalable Capital GmbH * %% diff --git a/samples/java-webtestclient/src/main/java/capital/scalable/restdocs/example/items/ItemResource.java b/samples/java-webflux/src/main/java/capital/scalable/restdocs/example/items/ItemResource.java similarity index 99% rename from samples/java-webtestclient/src/main/java/capital/scalable/restdocs/example/items/ItemResource.java rename to samples/java-webflux/src/main/java/capital/scalable/restdocs/example/items/ItemResource.java index dbd5ee86..e91c0ca0 100644 --- a/samples/java-webtestclient/src/main/java/capital/scalable/restdocs/example/items/ItemResource.java +++ b/samples/java-webflux/src/main/java/capital/scalable/restdocs/example/items/ItemResource.java @@ -1,6 +1,6 @@ /*- * #%L - * Spring Auto REST Docs Java WebTestClient Example Project + * Spring Auto REST Docs Java WebFlux Example Project * %% * Copyright (C) 2015 - 2018 Scalable Capital GmbH * %% diff --git a/samples/java-webtestclient/src/main/java/capital/scalable/restdocs/example/items/ItemResponse.java b/samples/java-webflux/src/main/java/capital/scalable/restdocs/example/items/ItemResponse.java similarity index 97% rename from samples/java-webtestclient/src/main/java/capital/scalable/restdocs/example/items/ItemResponse.java rename to samples/java-webflux/src/main/java/capital/scalable/restdocs/example/items/ItemResponse.java index 59ac311c..87309ead 100644 --- a/samples/java-webtestclient/src/main/java/capital/scalable/restdocs/example/items/ItemResponse.java +++ b/samples/java-webflux/src/main/java/capital/scalable/restdocs/example/items/ItemResponse.java @@ -1,6 +1,6 @@ /*- * #%L - * Spring Auto REST Docs Java WebTestClient Example Project + * Spring Auto REST Docs Java WebFlux Example Project * %% * Copyright (C) 2015 - 2018 Scalable Capital GmbH * %% diff --git a/samples/java-webtestclient/src/main/java/capital/scalable/restdocs/example/items/ItemUpdateRequest.java b/samples/java-webflux/src/main/java/capital/scalable/restdocs/example/items/ItemUpdateRequest.java similarity index 97% rename from samples/java-webtestclient/src/main/java/capital/scalable/restdocs/example/items/ItemUpdateRequest.java rename to samples/java-webflux/src/main/java/capital/scalable/restdocs/example/items/ItemUpdateRequest.java index 1dff60d1..72d73455 100644 --- a/samples/java-webtestclient/src/main/java/capital/scalable/restdocs/example/items/ItemUpdateRequest.java +++ b/samples/java-webflux/src/main/java/capital/scalable/restdocs/example/items/ItemUpdateRequest.java @@ -1,6 +1,6 @@ /*- * #%L - * Spring Auto REST Docs Java WebTestClient Example Project + * Spring Auto REST Docs Java WebFlux Example Project * %% * Copyright (C) 2015 - 2018 Scalable Capital GmbH * %% diff --git a/samples/java-webtestclient/src/main/java/capital/scalable/restdocs/example/jackson/JsonConfiguration.java b/samples/java-webflux/src/main/java/capital/scalable/restdocs/example/jackson/JsonConfiguration.java similarity index 96% rename from samples/java-webtestclient/src/main/java/capital/scalable/restdocs/example/jackson/JsonConfiguration.java rename to samples/java-webflux/src/main/java/capital/scalable/restdocs/example/jackson/JsonConfiguration.java index 5fcb4f4f..13303227 100644 --- a/samples/java-webtestclient/src/main/java/capital/scalable/restdocs/example/jackson/JsonConfiguration.java +++ b/samples/java-webflux/src/main/java/capital/scalable/restdocs/example/jackson/JsonConfiguration.java @@ -1,6 +1,6 @@ /*- * #%L - * Spring Auto REST Docs Java WebTestClient Example Project + * Spring Auto REST Docs Java WebFlux Example Project * %% * Copyright (C) 2015 - 2018 Scalable Capital GmbH * %% diff --git a/samples/java-webtestclient/src/main/java/capital/scalable/restdocs/example/security/CustomUserDetailsService.java b/samples/java-webflux/src/main/java/capital/scalable/restdocs/example/security/CustomUserDetailsService.java similarity index 96% rename from samples/java-webtestclient/src/main/java/capital/scalable/restdocs/example/security/CustomUserDetailsService.java rename to samples/java-webflux/src/main/java/capital/scalable/restdocs/example/security/CustomUserDetailsService.java index c98e03de..d49b6bab 100644 --- a/samples/java-webtestclient/src/main/java/capital/scalable/restdocs/example/security/CustomUserDetailsService.java +++ b/samples/java-webflux/src/main/java/capital/scalable/restdocs/example/security/CustomUserDetailsService.java @@ -1,6 +1,6 @@ /*- * #%L - * Spring Auto REST Docs Java WebTestClient Example Project + * Spring Auto REST Docs Java WebFlux Example Project * %% * Copyright (C) 2015 - 2018 Scalable Capital GmbH * %% diff --git a/samples/java-webtestclient/src/main/java/capital/scalable/restdocs/example/security/WebSecurityConfiguration.java b/samples/java-webflux/src/main/java/capital/scalable/restdocs/example/security/WebSecurityConfiguration.java similarity index 97% rename from samples/java-webtestclient/src/main/java/capital/scalable/restdocs/example/security/WebSecurityConfiguration.java rename to samples/java-webflux/src/main/java/capital/scalable/restdocs/example/security/WebSecurityConfiguration.java index 22fb1142..9a6f3295 100644 --- a/samples/java-webtestclient/src/main/java/capital/scalable/restdocs/example/security/WebSecurityConfiguration.java +++ b/samples/java-webflux/src/main/java/capital/scalable/restdocs/example/security/WebSecurityConfiguration.java @@ -1,15 +1,15 @@ /*- * #%L - * Spring Auto REST Docs Java WebTestClient Example Project + * Spring Auto REST Docs Java WebFlux Example Project * %% * Copyright (C) 2015 - 2018 Scalable Capital GmbH * %% * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. diff --git a/samples/java-webtestclient/src/test/java/capital/scalable/restdocs/example/items/ItemResourceTest.java b/samples/java-webflux/src/test/java/capital/scalable/restdocs/example/items/ItemResourceTest.java similarity index 99% rename from samples/java-webtestclient/src/test/java/capital/scalable/restdocs/example/items/ItemResourceTest.java rename to samples/java-webflux/src/test/java/capital/scalable/restdocs/example/items/ItemResourceTest.java index 2e90724f..6080c95e 100644 --- a/samples/java-webtestclient/src/test/java/capital/scalable/restdocs/example/items/ItemResourceTest.java +++ b/samples/java-webflux/src/test/java/capital/scalable/restdocs/example/items/ItemResourceTest.java @@ -1,6 +1,6 @@ /*- * #%L - * Spring Auto REST Docs Java WebTestClient Example Project + * Spring Auto REST Docs Java WebFlux Example Project * %% * Copyright (C) 2015 - 2018 Scalable Capital GmbH * %% diff --git a/samples/java-webtestclient/src/test/java/capital/scalable/restdocs/example/testsupport/WebTestClientTestBase.java b/samples/java-webflux/src/test/java/capital/scalable/restdocs/example/testsupport/WebTestClientTestBase.java similarity index 98% rename from samples/java-webtestclient/src/test/java/capital/scalable/restdocs/example/testsupport/WebTestClientTestBase.java rename to samples/java-webflux/src/test/java/capital/scalable/restdocs/example/testsupport/WebTestClientTestBase.java index e0bfb4ae..9275c263 100644 --- a/samples/java-webtestclient/src/test/java/capital/scalable/restdocs/example/testsupport/WebTestClientTestBase.java +++ b/samples/java-webflux/src/test/java/capital/scalable/restdocs/example/testsupport/WebTestClientTestBase.java @@ -1,6 +1,6 @@ /*- * #%L - * Spring Auto REST Docs Java WebTestClient Example Project + * Spring Auto REST Docs Java WebFlux Example Project * %% * Copyright (C) 2015 - 2018 Scalable Capital GmbH * %% @@ -41,7 +41,7 @@ import java.util.function.Consumer; -import capital.scalable.restdocs.webtestclient.WebTestClientInitializer; +import capital.scalable.restdocs.webflux.WebTestClientInitializer; import com.fasterxml.jackson.databind.ObjectMapper; import org.junit.Before; import org.junit.Rule; diff --git a/samples/java-webmvc/generated-docs/index.html b/samples/java-webmvc/generated-docs/index.html index cf5f2e40..b4dd77aa 100644 --- a/samples/java-webmvc/generated-docs/index.html +++ b/samples/java-webmvc/generated-docs/index.html @@ -1145,7 +1145,7 @@

$ curl 'http://localhost:8080/items' -i -X POST \
     -H 'Content-Type: application/json' \
-    -H 'Authorization: Bearer 412a28e4-f983-4b65-ace7-c287b1f34e33' \
+    -H 'Authorization: Bearer 46ab9c29-3e36-449c-bb8e-269196b13e4d' \
     -d '{"description":"Hot News"}'
@@ -1382,7 +1382,7 @@

$ curl 'http://localhost:8080/items/1' -i -X PUT \
     -H 'Content-Type: application/json' \
-    -H 'Authorization: Bearer 412a28e4-f983-4b65-ace7-c287b1f34e33' \
+    -H 'Authorization: Bearer 46ab9c29-3e36-449c-bb8e-269196b13e4d' \
     -d '{"description":"Hot News"}'
@@ -1488,7 +1488,7 @@

$ curl 'http://localhost:8080/items/1' -i -X DELETE \
-    -H 'Authorization: Bearer 412a28e4-f983-4b65-ace7-c287b1f34e33'
+ -H 'Authorization: Bearer 46ab9c29-3e36-449c-bb8e-269196b13e4d'
@@ -1989,13 +1989,13 @@

< "last" : true, "size" : 20, "number" : 0, + "first" : true, "numberOfElements" : 1, "sort" : { "orders" : [ ], "sorted" : false, "unsorted" : true - }, - "first" : true + } } diff --git a/samples/kotlin-webmvc/generated-docs/index.html b/samples/kotlin-webmvc/generated-docs/index.html index 852cdf30..7a15c9be 100644 --- a/samples/kotlin-webmvc/generated-docs/index.html +++ b/samples/kotlin-webmvc/generated-docs/index.html @@ -1130,7 +1130,7 @@

$ curl 'http://localhost:8080/items' -i -X POST \
     -H 'Content-Type: application/json' \
-    -H 'Authorization: Bearer d2329d42-eb9e-4c35-9c6f-08a627c45f0f' \
+    -H 'Authorization: Bearer e74119bc-d372-4c17-9263-931e0349e8ad' \
     -d '{"description":"Hot News"}'
@@ -1367,7 +1367,7 @@

$ curl 'http://localhost:8080/items/1' -i -X PUT \
     -H 'Content-Type: application/json' \
-    -H 'Authorization: Bearer d2329d42-eb9e-4c35-9c6f-08a627c45f0f' \
+    -H 'Authorization: Bearer e74119bc-d372-4c17-9263-931e0349e8ad' \
     -d '{"description":"Hot News"}'
@@ -1469,7 +1469,7 @@

$ curl 'http://localhost:8080/items/1' -i -X DELETE \
-    -H 'Authorization: Bearer d2329d42-eb9e-4c35-9c6f-08a627c45f0f'
+ -H 'Authorization: Bearer e74119bc-d372-4c17-9263-931e0349e8ad'
@@ -1957,17 +1957,17 @@

< "offset" : 0, "pageSize" : 20, "pageNumber" : 0, - "unpaged" : false, - "paged" : true + "paged" : true, + "unpaged" : false }, "total" : 1, "last" : true, - "totalElements" : 1, "totalPages" : 1, + "totalElements" : 1, "size" : 20, "number" : 0, - "numberOfElements" : 1, "first" : true, + "numberOfElements" : 1, "sort" : { "orders" : [ ], "sorted" : false, diff --git a/samples/pom.xml b/samples/pom.xml index f3fca636..abddc5ec 100644 --- a/samples/pom.xml +++ b/samples/pom.xml @@ -28,7 +28,7 @@ shared java-webmvc - java-webtestclient + java-webflux diff --git a/spring-auto-restdocs-core/src/main/java/capital/scalable/restdocs/webtestclient/WebTestClientInitializer.java b/spring-auto-restdocs-core/src/main/java/capital/scalable/restdocs/webflux/WebTestClientInitializer.java similarity index 99% rename from spring-auto-restdocs-core/src/main/java/capital/scalable/restdocs/webtestclient/WebTestClientInitializer.java rename to spring-auto-restdocs-core/src/main/java/capital/scalable/restdocs/webflux/WebTestClientInitializer.java index 2df0807d..fa4e357b 100644 --- a/spring-auto-restdocs-core/src/main/java/capital/scalable/restdocs/webtestclient/WebTestClientInitializer.java +++ b/spring-auto-restdocs-core/src/main/java/capital/scalable/restdocs/webflux/WebTestClientInitializer.java @@ -17,7 +17,7 @@ * limitations under the License. * #L% */ -package capital.scalable.restdocs.webtestclient; +package capital.scalable.restdocs.webflux; import capital.scalable.restdocs.constraints.ConstraintReader; import capital.scalable.restdocs.constraints.ConstraintReaderImpl; diff --git a/spring-auto-restdocs-core/src/test/java/capital/scalable/restdocs/webtestclient/WebTestClientInitializerTest.java b/spring-auto-restdocs-core/src/test/java/capital/scalable/restdocs/webflux/WebTestClientInitializerTest.java similarity index 99% rename from spring-auto-restdocs-core/src/test/java/capital/scalable/restdocs/webtestclient/WebTestClientInitializerTest.java rename to spring-auto-restdocs-core/src/test/java/capital/scalable/restdocs/webflux/WebTestClientInitializerTest.java index fa4a937c..70aee128 100644 --- a/spring-auto-restdocs-core/src/test/java/capital/scalable/restdocs/webtestclient/WebTestClientInitializerTest.java +++ b/spring-auto-restdocs-core/src/test/java/capital/scalable/restdocs/webflux/WebTestClientInitializerTest.java @@ -17,7 +17,7 @@ * limitations under the License. * #L% */ -package capital.scalable.restdocs.webtestclient; +package capital.scalable.restdocs.webflux; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertFalse; diff --git a/spring-auto-restdocs-docs/getting-started.adoc b/spring-auto-restdocs-docs/getting-started.adoc index 44ab6313..f42c5e92 100644 --- a/spring-auto-restdocs-docs/getting-started.adoc +++ b/spring-auto-restdocs-docs/getting-started.adoc @@ -253,7 +253,7 @@ repositories { This projects includes a https://github.com/ScaCap/spring-auto-restdocs/tree/master/samples/java-webmvc[Java Web MVC example], a -https://github.com/ScaCap/spring-auto-restdocs/tree/master/samples/java-webtestclient[Java WebTestClient example] +https://github.com/ScaCap/spring-auto-restdocs/tree/master/samples/java-webflux[Java WebFlux example] and a https://github.com/ScaCap/spring-auto-restdocs/tree/master/samples/kotlin-webmvc[Kotlin Web MVC example] application that demonstrate most features. @@ -261,6 +261,6 @@ application that demonstrate most features. The generated documentation can be viewed for the https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/master/samples/java-webmvc/generated-docs/index.html[Java Web MVC example], the -https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/master/samples/java-webtestclient/generated-docs/index.html[Java WebTestClient example] +https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/master/samples/java-webflux/generated-docs/index.html[Java WebFlux example] and the https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/master/samples/kotlin-webmvc/generated-docs/index.html[Kotlin Web MCV example]. diff --git a/spring-auto-restdocs-docs/index.adoc b/spring-auto-restdocs-docs/index.adoc index 11978837..0cb756bd 100644 --- a/spring-auto-restdocs-docs/index.adoc +++ b/spring-auto-restdocs-docs/index.adoc @@ -39,10 +39,18 @@ you write even less. == FAQ [qanda] -Does it work with Spring MVC tests?:: - Yes, it is easy to use in existing or new Spring MVC tests. Take a look at the example. -Does it work with Spring WebTestClient?:: - Yes, but only basic support yet. Take a look at the example. +Does it work with Spring Web MVC tests?:: + Yes, take a look at the https://github.com/ScaCap/spring-auto-restdocs/tree/master/samples/java-webmvc[example]. +Does it work with Spring WebFlux?:: + Yes, take a look at the https://github.com/ScaCap/spring-auto-restdocs/tree/master/samples/java-webflux[example]. +Is Kotlin supported?:: + Yes, Spring Auto REST Docs 1.0.13 and 2.0.0 introduced Kotlin support. + Instead of the Javadoc Doclet one has to use the Dokka extension + `spring-auto-restdocs-dokka-json`. The extension is only available as 2.0.x, + but works with both version of Spring Auto REST Docs. Take a look at the + https://github.com/ScaCap/spring-auto-restdocs/tree/master/samples/kotlin-webmvc[example]. +Is Java 9 supported?:: + Yes, see <>. Does it work with REST Assured tests?:: Not yet. We may add support for REST Assured in the future, but your PR is also welcome. Is Jackson required for automatic field documentation?:: @@ -58,13 +66,6 @@ Can Spring REST Docs and Spring Auto REST Docs features be combined?:: Yes, this even works in the same test. One can generate Spring REST Docs snippets and Spring Auto REST Docs snippets out of the same test. This is demonstrated in the example project. -Is Kotlin supported?:: - Yes, Spring Auto REST Docs 1.0.13 and 2.0.0 introduced Kotlin support. - Instead of the Javadoc Doclet one has to use the Dokka extension - `spring-auto-restdocs-dokka-json`. The extension is only available as 2.0.x, - but works with both version of Spring Auto REST Docs. -Is Java 9 supported?:: - Yes, see <>. include::getting-started.adoc[]