Spring Auto REST Docs Core

Spring Auto REST Docs is an extension to Spring REST Docs

License	Apache License, Version 2.0
Categories	Scala Languages Auto Application Layer Libs Code Generators
GroupId	capital.scalable
ArtifactId	spring-auto-restdocs-core
Last Version	2.0.11
Release Date	Apr 19, 2021
Type	jar
Description	Spring Auto REST Docs Core Spring Auto REST Docs is an extension to Spring REST Docs
Project Organization	Scalable Capital GmbH

Download spring-auto-restdocs-core

Filename	Size
spring-auto-restdocs-core-2.0.11.pom
spring-auto-restdocs-core-2.0.11.jar	121 KB
spring-auto-restdocs-core-2.0.11-sources.jar	97 KB
spring-auto-restdocs-core-2.0.11-javadoc.jar	369 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/capital.scalable/spring-auto-restdocs-core/ -->
<dependency>
    <groupId>capital.scalable</groupId>
    <artifactId>spring-auto-restdocs-core</artifactId>
    <version>2.0.11</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/capital.scalable/spring-auto-restdocs-core/
implementation 'capital.scalable:spring-auto-restdocs-core:2.0.11'

Gradle Kotlin

// https://jarcasting.com/artifacts/capital.scalable/spring-auto-restdocs-core/
implementation ("capital.scalable:spring-auto-restdocs-core:2.0.11")

Apache Buildr

'capital.scalable:spring-auto-restdocs-core:jar:2.0.11'

Apache Ivy

<dependency org="capital.scalable" name="spring-auto-restdocs-core" rev="2.0.11">
  <artifact name="spring-auto-restdocs-core" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='capital.scalable', module='spring-auto-restdocs-core', version='2.0.11')
)

Scala SBT

libraryDependencies += "capital.scalable" % "spring-auto-restdocs-core" % "2.0.11"

Leiningen

[capital.scalable/spring-auto-restdocs-core "2.0.11"]

Dependencies

compile (4)

Group / Artifact	Type	Version
capital.scalable : spring-auto-restdocs-annotations	jar	2.0.11
com.fasterxml.jackson.core : jackson-databind	jar	2.11.2
org.apache.commons : commons-lang3	jar	3.11
org.slf4j : slf4j-api	jar	1.7.30

provided (4)

Group / Artifact	Type	Version
org.springframework.restdocs : spring-restdocs-core	jar	2.0.5.RELEASE
org.springframework.restdocs : spring-restdocs-mockmvc	jar	2.0.5.RELEASE
org.springframework : spring-webflux	jar	5.2.5.RELEASE
org.springframework : spring-test	jar	5.2.5.RELEASE

test (9)

Group / Artifact	Type	Version
org.springframework.restdocs : spring-restdocs-core	jar	2.0.5.RELEASE
org.springframework.data : spring-data-commons	jar	2.3.4.RELEASE
org.springframework.boot : spring-boot-starter-hateoas	jar	2.0.5.RELEASE
junit : junit	jar	4.13.1
org.mockito : mockito-core	jar	3.5.10
org.slf4j : slf4j-simple	jar	1.7.30
org.hibernate.validator : hibernate-validator	jar	6.1.5.Final
org.apache.tomcat.embed : tomcat-embed-el	jar	9.0.37
org.assertj : assertj-core	jar	3.11.1

Project Modules

There are no modules declared in this project.

Spring Auto REST Docs

The aim of this Spring REST Docs 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 article. The slides and the video recording from the Introducing Spring Auto REST Docs talk at Spring IO 2017 are also available.

Documentation

Current 2.0.11 release reference guide (based on Spring REST Docs 2.x).

Legacy 1.0.15 release reference guide (based on Spring REST Docs 1.x).

Latest master 2.0.12-SNAPSHOT reference guide.

Main features

• Automatic documentation of request and response fields, path, query parameters and request headers using Jackson and Javadoc/KDoc
• Automatic documentation of field and parameter optionality and constraints using JSR 303 annotations
• Automatic documentation of entire endpoint with customizations
• A helper to document authentication
• Support for paging
• Convenient preprocessors

Usage

See the Getting started section in the documentation.

Sample projects

• Java WebMVC: Spring Boot 2.3, WebMVC, JUnit 4, Java 8/11/14, Maven/Gradle
• Java WebFlux: Spring Boot 2.3, WebFlux, JUnit 4, Java 8/11/14, Maven
• Kotlin WebMVC: Spring Boot 2.3, WebMVC, JUnit 5, Kotlin 1.4, Maven/Gradle

All sample projects use shared POJOs to demonstarte the usage across projects.

Building from source

See the Building from source 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 tag.

License

Spring Auto REST Docs is Open Source software released under the Apache 2.0 license.

Scalable Capital

Versions

Version
2.0.11 Apr 19, 2021
2.0.10 Mar 17, 2021
2.0.9 Aug 10, 2020
2.0.8 Mar 3, 2020
2.0.7 Oct 7, 2019
2.0.6 Jul 18, 2019
2.0.5 May 6, 2019
2.0.4 Mar 16, 2019
2.0.3 Dec 6, 2018
2.0.2 Sep 20, 2018
2.0.1 Mar 29, 2018
2.0.0 Mar 24, 2018
1.0.15 May 6, 2019
1.0.14 Nov 6, 2018
1.0.13 Mar 29, 2018
1.0.12 Mar 23, 2018
1.0.11 Jan 10, 2018
1.0.10 Nov 3, 2017
1.0.9 Sep 12, 2017
1.0.8 Jul 10, 2017
1.0.7 May 11, 2017
1.0.6 Mar 2, 2017
1.0.5 Feb 1, 2017
1.0.4 Dec 20, 2016