https://github.com/ScaCap/spring-auto-restdocs
Spring Auto REST Docs is an extension to Spring REST Docs
https://github.com/ScaCap/spring-auto-restdocs
asciidoc documentation dokka java kotlin restdocs spring-auto-restdocs spring-boot spring-rest-docs
Last synced: about 2 months ago
JSON representation
Spring Auto REST Docs is an extension to Spring REST Docs
- Host: GitHub
- URL: https://github.com/ScaCap/spring-auto-restdocs
- Owner: ScaCap
- License: apache-2.0
- Archived: true
- Created: 2015-12-23T16:38:34.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-12-19T14:18:15.000Z (over 1 year ago)
- Last Synced: 2024-11-15T05:57:24.047Z (7 months ago)
- Topics: asciidoc, documentation, dokka, java, kotlin, restdocs, spring-auto-restdocs, spring-boot, spring-rest-docs
- Language: Java
- Homepage: https://scacap.github.io/spring-auto-restdocs/
- Size: 4.14 MB
- Stars: 311
- Watchers: 51
- Forks: 86
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# End-of-life Notice
This project is officially end-of-life. Users are welcome to maintain it in a
fork, but there will be no more Scalable-authored changes published. While Spring
Auto REST Docs helped us over the years to maintain our API documentation,
we decided to move to [OpenAPI] and phased out the usage internally. At Scalable,
[springdoc-openapi] helps us now to automate the generation of API documentation.
[OpenAPI]: https://www.openapis.org/
[springdoc-openapi]: https://springdoc.org/
---
# Spring Auto REST Docs
[](https://www.apache.org/licenses/LICENSE-2.0.txt)
[](https://github.com/ScaCap/spring-auto-restdocs/actions/workflows/build.yaml)
[](https://search.maven.org/#search%7Cga%7C1%7Ccapital.scalable%20spring-auto-restdocs)
The aim of this [Spring REST Docs](https://projects.spring.io/spring-restdocs/)
extension is to help you write even less - both code and documentation.
You still get the same nice documentation as with Spring REST Docs itself.
The main benefit is that writing less and moving the documentation closer
to the code increases the maintainability of the documentation.
In Spring REST Docs you have to add the documentation for your JSON with
a DSL in your test. We moved this documentation to the POJO that represents
your JSON object. You just add Javadoc to the fields and it will end
up in the documentation.
Learn more in the [Introducing Spring Auto REST Docs](https://dzone.com/articles/introducing-spring-auto-rest-docs) article.
The [slides](https://www.slideshare.net/fbenz/introducing-spring-auto-rest-docs)
and the
[video recording](https://www.youtube.com/watch?v=M7GEN6Jh6CQ)
from the Introducing Spring Auto REST Docs talk at Spring IO 2017 are also available.
## Documentation
[Current 2.0.11 release](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v2.0.11/docs/index.html) reference guide (based on Spring REST Docs 2.x).
[Legacy 1.0.15 release](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.15/docs/index.html) reference guide (based on Spring REST Docs 1.x).
Latest master [2.0.12-SNAPSHOT](https://scacap.github.io/spring-auto-restdocs) reference guide.
## Main features
* Automatic documentation of
[request](https://scacap.github.io/spring-auto-restdocs/#snippets-request-fields) and
[response](https://scacap.github.io/spring-auto-restdocs/#snippets-response-fields) fields,
[path](https://scacap.github.io/spring-auto-restdocs/#snippets-path-parameters),
[query parameters](https://scacap.github.io/spring-auto-restdocs/#snippets-request-parameters) and
[request headers](https://scacap.github.io/spring-auto-restdocs/#snippets-request-headers)
using Jackson and Javadoc/KDoc
* Automatic documentation of field and parameter
[optionality](https://scacap.github.io/spring-auto-restdocs/#constraints-optionality) and
[constraints](https://scacap.github.io/spring-auto-restdocs/#constraints) using JSR 303 annotations
* Automatic documentation of [entire endpoint](https://scacap.github.io/spring-auto-restdocs/#snippets-section) with [customizations](https://scacap.github.io/spring-auto-restdocs/#snippets-section-customization)
* A helper to document [authentication](https://scacap.github.io/spring-auto-restdocs/#snippets-authorization)
* Support for [paging](https://scacap.github.io/spring-auto-restdocs/#paging)
* Convenient [preprocessors](https://scacap.github.io/spring-auto-restdocs/#preprocessors)
## Usage
See the [Getting started](https://scacap.github.io/spring-auto-restdocs/#gettingstarted) section in the documentation.
## Sample projects
* [Java WebMVC](https://github.com/ScaCap/spring-auto-restdocs/tree/master/samples/java-webmvc): Spring Boot 2.3, WebMVC, JUnit 4, Java 8/11/14, Maven/Gradle
* [Java WebFlux](https://github.com/ScaCap/spring-auto-restdocs/tree/master/samples/java-webflux): Spring Boot 2.3, WebFlux, JUnit 4, Java 8/11/14, Maven
* [Kotlin WebMVC](https://github.com/ScaCap/spring-auto-restdocs/tree/master/samples/kotlin-webmvc): Spring Boot 2.3, WebMVC, JUnit 5, Kotlin 1.4, Maven/Gradle
All sample projects use [shared POJOs](https://github.com/ScaCap/spring-auto-restdocs/tree/master/samples/shared)
to demonstarte the usage across projects.
## Building from source
See the [Building from source](https://scacap.github.io/spring-auto-restdocs/#contributing-building) section in the documentation.
## Contributing
- Submit a Pull Request for any enhancement you made.
- Create an issue describing your particular problem.
- Ask and answer questions on Stack Overflow using the [spring-auto-restdocs](https://stackoverflow.com/tags/spring-auto-restdocs) tag.
## License
Spring Auto REST Docs is Open Source software released under the
[Apache 2.0 license](http://www.apache.org/licenses/LICENSE-2.0.html).