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

update README.md and README_CN.md

This commit is contained in:
oppofind 2021-04-25 21:37:32 +08:00
parent 754785fff4
commit d3b9e9c84d
2 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -169,6 +169,9 @@ When you need to use smart-doc to generate more API document information, you ca
"responseBodyAdvice":{ //Support ResponseBodyAdvice
"className":"com.power.common.model.CommonResult" // Standard POJO for Response
},
"requestBodyAdvice":{ //Support ResponseBodyAdvice
"className":"com.power.common.model.CommonResult" // Standard POJO for Request
},
"rpcConsumerConfig": "src/main/resources/consumer-example.conf",//dubbo consumer config example
"requestHeaders": [{// Set global request headers, no need to set
"name": "token",

3
README_CN.md
View File

@ -189,6 +189,9 @@ smart-doc官方目前已经开发完成[Maven插件](https://gitee.com/smart-doc
"responseBodyAdvice":{ //自smart-doc 1.9.8起，ResponseBodyAdvice统一返回设置，可用ignoreResponseBodyAdvice tag来忽略
"className":"com.power.common.model.CommonResult" //通用响应体
},
"requestBodyAdvice":{ ////自smart-doc 2.1.4 起，支持设置RequestBodyAdvice统一请求包装类
"className":"com.power.common.model.CommonResult"
},
"sourceCodePaths": [{ //设置代码路径, 插件已经能够自动下载发布的源码包，没必要配置
"path": "src/main/java",
"desc": "测试"