update README.md and README_CN.md

This commit is contained in:
oppofind 2020-12-22 23:50:51 +08:00
parent 0b06704276
commit ce60956360
3 changed files with 5 additions and 3 deletions

View File

@ -8,6 +8,7 @@
3. debug页面可以根据请求动态更新curl命令。
4. 优化debug页面中的文件下载测试。
5. 优化enum入参mock错误的bug。
6. mock页面支持使用新窗口打开后端渲染的页面。
#### 版本号2.0.1
- 更新日期: 2020-12-20
- 更新内容:

View File

@ -75,7 +75,7 @@ The configuration contents are as follows.
{
"allInOne": true, // whether to merge documents into one file, generally recommended as true
"isStrict": false,//If the strict mode is set to true, Smart-doc forces that the public method in each interface in the code has a comment.
"outPath": "/src/main/resources" //Set the api document output path.
"outPath": "src/main/resources/static/doc" //Set the api document output path.
}
```
Only the above three simple configuration items can make smart-doc-maven-plugin work.
@ -89,7 +89,7 @@ When you need to use smart-doc to generate more API document information, you ca
  "serverUrl": "http://127.0.0.1", // Set the server address, not required
  "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
  "outPath": "src/main/resources/static/doc", // Specify the output path of the document
  "coverOld": true, // Whether to overwrite old files, mainly used for mardown file overwrite
  "packageFilters": "", // controller package filtering, multiple package names separated by commas
  "md5EncryptedHtmlName": false, // only used if each controller generates an html file

View File

@ -86,8 +86,9 @@ smart-doc官方目前已经开发完成[Maven插件](https://gitee.com/smart-doc
"outPath": "D://md2" //指定文档的输出路径,相对路径时请用./开头eg:./src/main/resources/static/doc
}
```
仅仅需要上面一行配置就能启动smart-doc-maven-plugin插件根据自己项目情况更多详细的配置参考下面。
>如果你想把html文档也打包到应用中一起访问则建议你配置路径为src/main/resources/static/doc
仅仅需要上面一行配置就能启动smart-doc-maven-plugin插件根据自己项目情况更多详细的配置参考下面。
**详细配置说明**
```
{