Skip to content

Commit

Permalink
Merge pull request #17 from shalousun/master
Browse files Browse the repository at this point in the history
update: config.md, add randomMock option
  • Loading branch information
shalousun authored May 14, 2023
2 parents 88f56b1 + bbcf707 commit 19f7b65
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/diy/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ Example of a complete configuration file
"isStrict": false, // whether to enable strict mode
"allInOne": true, // whether to merge documents into one file, generally recommended as true
"outPath": "D: // md2", // Specify the output path of the document
"randomMock":false,// Whether to generate a random mock, the default is false,@since 2.6.9
"coverOld": true, // Whether to overwrite old files, mainly used for mardown file overwrite
"createDebugPage": true,//Create a page that can be used to test your APIs like swagger
"packageFilters": "", // controller package filtering, multiple package names separated by commas
"createDebugPage": true,//Create a page that can be used to test your APIs like swagger
"packageFilters": "", // controller package filtering, multiple package names separated by commas
"packageExcludeFilters": "",//Exclude subpackages under the packageFilters package
"md5EncryptedHtmlName": false, // only used if each controller generates an html file
"style":"xt256", //set highlight
Expand Down
1 change: 1 addition & 0 deletions docs/zh-cn/diy/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
"isStrict": false, //是否开启严格模式,严格模式会检查代码注释,在2.6.3即以后的插件版本设置此项时检查到注释错误也会直接中断插件白嵌套的构建周期
"allInOne": true, //是否将文档合并到一个文件中,一般推荐为true
"outPath": "D://md2", //指定文档的输出路径
"randomMock":false,//是否生成随机mock,默认false,@since 2.6.9
"coverOld": true, //是否覆盖旧的文件,主要用于mardown文件覆盖
"createDebugPage": true,//@since 2.0.0 创建一个类似swagger的可调试接口的文档页面,仅在AllInOne模式中起作用。
"packageFilters": "",//controller包过滤,多个包用英文逗号隔开,2.2.2开始需要采用正则:com.test.controller.*
Expand Down

0 comments on commit 19f7b65

Please sign in to comment.