Spring/spring-restdocs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Provide API guide examples alongside existing getting started guides

Browse Source
This commit is contained in:
Andy Wilkinson
2014-11-04 16:01:14 +00:00
parent 5168fcf93e
commit d06095ee72
12 changed files with 1487 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -27,10 +27,11 @@ $ cd rest-notes-spring-data-rest
$ ./gradlew restDocumentation
```
Once the build is complete, open the generated documentation:
Once the build is complete, open on of the generated pieces HTML documentation:
```
open build/asciidoc/main.html
open build/asciidoc/getting-started-guide.html
open build/asciidoc/api-guide.html
```
Every example request and response in the documentation is auto-generated using custom