mindol1004/swagger2markup
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated documentation

Browse Source
This commit is contained in:
Robert Winkler
2015-02-19 14:14:17 +01:00
parent 84d64ec6f6
commit 97541bfc83
1 changed files with 11 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.adoc
View File

@@ -138,28 +138,31 @@ image::images/mkdocs_html.PNG[mkdocs_html]
image::images/asciidoc_pdf.PNG[asciidoc_pdf]
== Integration with spring-restdocs.
spring-restdocs can be used together with Swagger2Markup.
== Integration with spring-restdocs
https://github.com/spring-projects/spring-restdocs[spring-restdocs] can be used together with Swagger2Markup.
Swagger2Markup can include the generated examples from spring-restdocs into the generated AsciiDoc document.
Currently it does not work for Markdown, since spring-restdocs generates AsciiDoc files.
Currently it does not work for Markdown, since spring-restdocs generates only AsciiDoc files.
Let's say I have a Swagger-annotated Controller method with a ApiOperation value _"Create a quota"_
Let's say I have a Swagger-annotated Spring RestController method with an ApiOperation value: _"Create a quota"_
```java
@ApiOperation(value = "Create a quota.", notes = "Create a quota allows bla bla bla bla")
public void createMailStorageQuota(@ApiParam(name = "MailStorageQuota", value = "MailStorageQuota", required = true) @RequestBody MailStorageQuota mailStorageQuota) {
@ApiOperation(value = "Create a quota", notes = "Create a quota allows bla bla bla bla")
public void createMailStorageQuota(@ApiParam(name = "MailStorageQuota",
value = "MailStorageQuota", required = true) @RequestBody MailStorageQuota mailStorageQuota) {
}
```
I'm using spring-restdocs in combination with https://github.com/jayway/rest-assured to test the Controller.
The target folder of the generated request and response example files must be _"create_a_quota"_.
The target folder of the generated request and response example files must be _"create_a_quota"_ (similar to the value of the ApiOperation).
```java
given().contentType(ContentType.XML).body(storageQuota).resultHandlers(document("create_a_quota")).
when().put("/quotas").
then().statusCode(204);
```
The output directory is configured as follows:
The spring-restdocs output directory is configured as follows:
```
io.restdocumented.outputDir = docs/generated
```