Skip to content

spring-projects/spring-restdocs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

8fd536c · Feb 3, 2025
Jan 30, 2025
Jul 18, 2024
Mar 28, 2024
Jul 18, 2022
Jan 30, 2025
Jul 15, 2022
Sep 30, 2024
Feb 3, 2025
Jul 15, 2022
Jan 30, 2025
Jan 30, 2025
Jan 30, 2025
Feb 3, 2025
Jan 30, 2025
Apr 20, 2015
Sep 13, 2024
Mar 26, 2019
Jan 15, 2025
May 24, 2022
Jan 16, 2025
Jan 30, 2025
Jan 30, 2025
Sep 30, 2024
Sep 30, 2024
Sep 30, 2024

Spring REST Docs Build status Revved up by Develocity

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 17 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.