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

Update README to recommend that pretty printing of JSON is enabled

Browse Source 
Closes gh-16
This commit is contained in:
Ronald Kurr
2015-02-18 10:38:15 -05:00
committed by Andy Wilkinson
parent 565a57e5da
commit 289ba57159
2 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -283,6 +283,13 @@ be written:
- `index/response.asciidoc`
- `index/request-response.asciidoc`
#### Pretty-printed snippets
To improve the readability of the generated snippets you may want to configure your
application to produce JSON that has been pretty-printed. If you are a Spring Boot
user you can do so by setting the `spring.jackson.serialization.indent_output` property
to `true`.
### Hand-written documentation
Producing high-quality, easily readable documentation is difficult and the process is

2
samples/rest-notes-spring-hateoas/src/main/resources/application.properties
View File

@@ -1 +1 @@
http.mappers.json-pretty-print: true
spring.jackson.serialization.indent_output: true