From 6c2167b1488e554ccc47e4c07ff7c4a19050ec2e Mon Sep 17 00:00:00 2001 From: oppofind <836575280@qq.com> Date: Wed, 24 Mar 2021 22:38:07 +0800 Subject: [PATCH] update README.md and README_CN.md --- README.md | 2 ++ README_CN.md | 3 ++- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dd8cc612..5dbbab34 100644 --- a/README.md +++ b/README.md @@ -106,6 +106,7 @@ When you need to use smart-doc to generate more API document information, you ca "requestFieldToUnderline":true, //convert request field to underline "responseFieldToUnderline":true,//convert response field to underline "sortByTitle":false,//Sort by interface title, the default value is false + "showAuthor":true,// display author,default is true "inlineEnum":true,// Set to true to display enumeration details in the parameter table "recursionLimit":7,// Set the number of recursive executions to avoid stack overflow, the default is 7 "allInOneDocFileName":"index.html",//Customize the output document name @@ -117,6 +118,7 @@ When you need to use smart-doc to generate more API document information, you ca "appToken": "xxx", //torna appToken,@since 2.0.9 "secret": "xx",//torna secret,@since 2.0.9 "openUrl": "torna server/api/",//torna server url,@since 2.0.9 + "tornaDebug":false,"// show log while set true "ignoreRequestParams":[ //The request parameter object will be discarded when generating the document.@since 1.9.2 "org.springframework.ui.ModelMap" ], diff --git a/README_CN.md b/README_CN.md index 7886bcf4..f2c9a212 100644 --- a/README_CN.md +++ b/README_CN.md @@ -126,8 +126,9 @@ smart-doc官方目前已经开发完成[Maven插件](https://gitee.com/smart-doc "appToken": "c16931fa6590483fb7a4e85340fcbfef", //torna平台appToken,@since 2.0.9 "secret": "W.ZyGMOB9Q0UqujVxnfi@.I#V&tUUYZR",//torna平台secret,@since 2.0.9 "openUrl": "http://localhost:7700/api",//torna平台地址,填写自己的私有化部署地址@since 2.0.9 - "debugEnvName":"测试环境", //torna测试环境 + "debugEnvName":"测试环境", //torna环境名称 "debugEnvUrl":"http://127.0.0.1",//推送torna配置接口服务地址 + "tornaDebug":false,//启用会推送日志 "ignoreRequestParams":[ //忽略请求参数对象,把不想生成文档的参数对象屏蔽掉,@since 1.9.2 "org.springframework.ui.ModelMap" ],