Skip to content

Commit 8470def

Browse files
committed
release 2.0.9
1 parent 10babbb commit 8470def

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@ Start smart-doc to scan source code analysis and generate API documents.
1616
You can run the `gradle` command directly or click on the preset` goal` of the smart-doc-maven-plugin in the IDE to generate API documentation.
1717
smart-doc-gradle-plugin will also make smart-doc's ability to generate API documentation more powerful.
1818
[About smart-doc](https://github.com/shalousun/smart-doc)
19+
## Best Practice
20+
smart-doc + [Torna](http://torna.cn) form an industry-leading document generation and management solution, using smart-doc to complete Java source code analysis and extract annotations to generate API documents without intrusion, and automatically push the documents to the Torna enterprise-level interface document management platform.
1921

22+
![smart-doc+torna](https://raw.githubusercontent.com/shalousun/smart-doc/master/images/smart-doc-torna.png)
2023
## Getting started
2124
### Add plugin
2225
Using the plugins DSL:
@@ -121,6 +124,10 @@ When you need to use smart-doc to generate more API document information, you ca
121124
"requestExample":"true",//Whether to display the request example in the document, the default value is true.
122125
"responseExample":"true",//Whether to display the response example in the document, the default is true.
123126
"displayActualType":false,//display actual type of generic,
127+
"appKey": "xxx",// torna appKey, @since 2.0.9
128+
"appToken": "xxx", //torna appToken,@since 2.0.9
129+
"secret": "xx",//torna secret,@since 2.0.9
130+
"openUrl": "torna server/api/",//torna server url,@since 2.0.9
124131
"ignoreRequestParams":[ //The request parameter object will be discarded when generating the document.@since 1.9.2
125132
"org.springframework.ui.ModelMap"
126133
],

README_CN.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,10 @@ smart-doc-gradle-plugin底层完全依赖于官方开源的smart-doc解析库,
1414
因此整个使用过程中遇到问题或者是想查看完整解决方案请前往码云smart-doc的仓库查看wiki文档。
1515

1616
[关于smart-doc](https://gitee.com/smart-doc-team/smart-doc)
17+
## Best Practice
18+
smart-doc + [Torna](http://torna.cn) 组成行业领先的文档生成和管理解决方案,使用smart-doc无侵入完成Java源代码分析和提取注释生成API文档,自动将文档推送到Torna企业级接口文档管理平台。
1719

20+
![smart-doc+torna](https://gitee.com/smart-doc-team/smart-doc/raw/master/images/smart-doc-torna.png)
1821
## Getting started
1922
### Add plugin
2023
Using the plugins DSL:
@@ -112,6 +115,12 @@ subprojects{
112115
"requestExample":"true",//是否将请求示例展示在文档中,默认true,@since smart-doc 1.9.0
113116
"responseExample":"true",//是否将响应示例展示在文档中,默认为true,@since smart-doc 1.9.0
114117
"displayActualType":false,//配置true会在注释栏自动显示泛型的真实类型短类名,@since 1.9.6
118+
"appKey": "xxx",// torna平台对接appKey,, @since 2.0.9
119+
"appToken": "xxx", //torna平台appToken,@since 2.0.9
120+
"secret": "xx",//torna平台secret,@since 2.0.9
121+
"openUrl": "torna server/api/",//torna平台地址,填写自己的私有化部署地址@since 2.0.9
122+
"debugEnvName":"测试环境", //torna测试环境
123+
"debugEnvUrl":"http://127.0.0.1",//torna
115124
"ignoreRequestParams":[ //忽略请求参数对象,把不想生成文档的参数对象屏蔽掉,@since smart-doc 1.9.2
116125
"org.springframework.ui.ModelMap"
117126
],

0 commit comments

Comments
 (0)