Skip to content
This repository was archived by the owner on Dec 19, 2023. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions spring-auto-restdocs-docs/getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,16 @@

Spring Auto REST Docs has the following minimum requirements:

* Java 8 or Kotlin 1.2
* Java 8 or Kotlin 1.3
* Spring REST Docs ${spring-restdocs.version} (see http://docs.spring.io/spring-restdocs/docs/${spring-restdocs.version}/reference/html5/[documentation])
* Jackson has to be used for creating and parsing JSON

For Java 7 and Spring REST Docs 1.2.x support,
please use the 1.0.x version of Spring Auto REST Docs.

For Java 9/10/11 support, use `spring-auto-restdocs-json-doclet-jdk9` as doclet dependency.
For Java 9+ support, use `spring-auto-restdocs-json-doclet-jdk9` as doclet dependency.
Our support is focused on the latest Kotlin version, Java 8 and 11.
In addition, we try to support the latest Java version that is supported by Spring.

[[gettingstarted-usage]]
=== Usage
Expand Down
2 changes: 2 additions & 0 deletions spring-auto-restdocs-docs/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@ Can I regenerate the final HTML without running all tests?::
in your setup. You might have to remove `dependsOn test` depending on your setup to run it standalone.
Is HATEOAS supported?::
Yes, there is basic support for <<snippets-links,links>> and <<snippets-embedded,embedded>> resources.
What should I do if I get a `NoSuchBeanDefinitionException: No bean named 'webHandler' available` exception?::
This means that the servlet stack instead if the reactive one is active. Make sure that `@EnableWebFlux` is used.

include::getting-started.adoc[]

Expand Down