99ee889708
Previously, REST Docs' JUnit Jupiter extension, RestDocumentationExtension, stored its own state. Since the code was written I have learned that this isn't recommended and that the extension context's store should be used instead. Up until now, we'd got away with the extension being stateful, but the introduction of parallel test execution has highlighted the problem. This commit updates RestDocumentationExtension to use the store from the execution context rather than storing its own state. An unwanted, but necessary, side-effect of this is that RestDocumentationExtension itself no longer implements RestDocumentationContextProvider and, instead, returns a new type rather than itself when asked to resolve the provider. This is technically a breaking API change, but users will be unaffected if they have followed the recommended and documented approach of injecting RestDocumentationContextProvider. Closes gh-520
Spring REST Docs 
Overview
The primary goal of this project is to make it easy to document RESTful services by combining content that's been hand-written using Asciidoctor with auto-generated examples produced with the Spring MVC Test framework. The result is intended to be an easy-to-read user guide, akin to GitHub's API documentation for example, rather than the fully automated, dense API documentation produced by tools like Swagger.
For a broader introduction see the Documenting RESTful APIs presentation. Both the slides and a video recording are available.
Learning more
To learn more about Spring REST Docs, please consult the reference documentation.
Building from source
You will need Java 8 or later to build Spring REST Docs. It is built using Gradle:
./gradlew build
Contributing
Contributors to this project agree to uphold its code of conduct.
There are several that you can contribute to Spring REST Docs:
- Open a pull request. Please see the contributor guidelines for details.
- Ask and answer questions on Stack Overflow using the
spring-restdocstag. - Chat with fellow users on Gitter.
Third-party extensions
| Name | Description |
|---|---|
| restdocs-wiremock | Auto-generate WireMock stubs as part of documenting your RESTful API |
| restdocsext-jersey | Enables Spring REST Docs to be used with Jersey's test framework |
| spring-auto-restdocs | Uses introspection and Javadoc to automatically document request and response parameters |
| restdocs-raml | A Spring REST Docs extension that adds RAML support |
Licence
Spring REST Docs is open source software released under the Apache 2.0 license.