wanjia950611
/
smart-doc
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

update readme

This commit is contained in:
oppofind 2019-12-31 22:56:41 +08:00
parent 69cb4b5e81
commit b2ad4bb081
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -137,6 +137,9 @@ public class ApiDocTest {
![request-params](https://images.gitee.com/uploads/images/2019/1231/223710_88933f55_144669.png "request.png") ![request-params](https://images.gitee.com/uploads/images/2019/1231/223710_88933f55_144669.png "request.png")
#### Response parameter example renderings #### Response parameter example renderings
![response-fields](https://images.gitee.com/uploads/images/2019/1231/223817_32bea6dc_144669.png "response.png") ![response-fields](https://images.gitee.com/uploads/images/2019/1231/223817_32bea6dc_144669.png "response.png")
## Use Maven Plugin
Smart-doc provides a maven plugin to quickly integrate into the project to generate documentation.
You can use the plugin instead of the unit test above.[smart-doc-maven-plugin](https://github.com/shalousun/smart-doc-maven-plugin)
## Building ## Building
you can build with the following commands. (Java 1.8 is required to build the master branch) you can build with the following commands. (Java 1.8 is required to build the master branch)
``` ```