Andy Wilkinson 02c6c89172 Allow documentation of extra attributes that apply to the whole snippet
This commit adds support for associating custom attributes with the
generation of a particular snippet. The attributes are included in
the model during snippet rendering allowing them to be referenced from
a custom snippet template. Among other things, this makes it possible
to provide a configurable title for snippets that produce a code
block.

Closes gh-77
2015-07-28 11:05:28 +01:00
2014-10-08 14:04:52 +01:00
2014-10-08 14:04:52 +01:00

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

Spring REST Docs requires Java 7 or later and is built using Gradle:

./gradlew build

Contributing

Pull requests are welcome. Please see the contributor guidelines for details.

Licence

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

Description
No description provided
Readme 6.8 MiB
Languages
Java 98.2%
Groovy 1.3%
Vim Snippet 0.5%