Skip to content
Test-driven documentation for RESTful services
Java Other
  1. Java 98.1%
  2. Other 1.9%
Branch: master
Clone or download
wilkinsona Merge pull request #656 from izeye
* gh-656:
  Upgrade the Spring Boot-based samples to 2.1.9.RELEASE

Closes gh-656
Latest commit 34a007c Oct 25, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
buildSrc/src/main Fix matrix testing with single selector that has multiple versions Jun 18, 2019
config Add NoHTTP to the build Jun 10, 2019
docs Polish "Mention WebTestClient in Gradle getting started example" Oct 24, 2019
gradle Merge branch '1.1.x' into 1.2.x Mar 19, 2019
samples Upgrade the Spring Boot-based samples to 2.1.9.RELEASE Oct 25, 2019
spring-restdocs-asciidoctor-1.5 Merge branch '1.2.x' Aug 30, 2019
spring-restdocs-asciidoctor-1.6 Merge branch '1.2.x' Aug 30, 2019
spring-restdocs-asciidoctor-2.x Broaden compatibility testing for Asciidoctor 2.x Sep 13, 2019
spring-restdocs-asciidoctor-support Fix problem with operation block macro when using leveloffset Oct 17, 2019
spring-restdocs-asciidoctor Fix problem with operation block macro when using leveloffset Oct 17, 2019
spring-restdocs-core Polish "Fix NPE in HttpResponseSnippet when response has custom status" Oct 22, 2019
spring-restdocs-mockmvc Fix handling of empty querty string parameters Oct 4, 2019
spring-restdocs-restassured Fix handling of empty querty string parameters Oct 4, 2019
spring-restdocs-webtestclient Fix handling of empty querty string parameters Oct 4, 2019
.gitignore Add the files that were accidentally excluded by .gitignore Apr 20, 2015
CODE_OF_CONDUCT.md Use HTTPS for external links where possible Mar 26, 2019
CONTRIBUTING.md Merge branch '1.2.x' Mar 26, 2019
README.md Fix minor mistake made from last merge for `README.md` Apr 15, 2019
build.gradle Fix generation of javadoc for the documentation zip Sep 29, 2019
gradle.properties Next development version Sep 30, 2019
gradlew Upgrade main build and Gradle-based samples to Gradle 3.4.1 Mar 23, 2017
gradlew.bat Upgrade main build and Gradle-based samples to Gradle 3.4.1 Mar 23, 2017
settings.gradle

README.md

Spring REST Docs Build status

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:

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-api-spec A Spring REST Docs extension that adds API specification support. It currently supports OpenAPI 2 and OpenAPI 3

Licence

Spring REST Docs is open source software released under the Apache 2.0 license.

You can’t perform that action at this time.