release 2.0.9

CHANGELOG.md

@@ -1,5 +1,11 @@
 ## smart-doc版本
 版本小于1.0都属于试用，正式1.0起始发布将会等到文中提到的问题解决后才发布。
+#### 版本号：2.0.9
+- 更新日期: 2020-03-12
+- 更新内容：
+    1. 支持UUID和ZonedDateTime字段类型，#89。
+    2. 对map参数增加开关来兼容旧项目，还是不建议使用map参数。
+    3. 完成和Torna的对接。
 #### 版本号：2.0.8
 - 更新日期: 2020-02-26
 - 更新内容：

README.md

@@ -24,6 +24,10 @@ smart-doc does not need to inject annotations into the code like Swagger.
 - Support for exporting error codes and data dictionary codes to API documentation.
 - The debug html5 page fully supports file upload and download testing.
 - Support Apache Dubbo RPC.
+## Best Practice
+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.
+
+![smart-doc+torna](http://torna.cn/assets/images/case/smart-doc.png)
 ## Getting Started
 [Smart-doc Samples](https://github.com/shalousun/smart-doc-demo.git)。
 ```
@@ -108,6 +112,10 @@ When you need to use smart-doc to generate more API document information, you ca
   "requestExample":"true",//Whether to display the request example in the document, the default value is true.
   "responseExample":"true",//Whether to display the response example in the document, the default is true.
   "displayActualType":false,//display actual type of generic,
+  "appKey": "xxx",// torna appKey, @since 2.0.9
+  "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
   "ignoreRequestParams":[ //The request parameter object will be discarded when generating the document.@since 1.9.2
        "org.springframework.ui.ModelMap"
   ],
@@ -166,13 +174,15 @@ So the project configuration can also refer to the introduction of smart-doc.
 #### Run Plugin with MAVEN command
 ```
 // Generate html
-mvn -Dfile.encoding=UTF-8 smart-doc: html
+mvn -Dfile.encoding=UTF-8 smart-doc:html
 // Generate markdown
-mvn -Dfile.encoding=UTF-8 smart-doc: markdown
+mvn -Dfile.encoding=UTF-8 smart-doc:markdown
 // Generate adoc
-mvn -Dfile.encoding=UTF-8 smart-doc: adoc
+mvn -Dfile.encoding=UTF-8 smart-doc:adoc
 // Generate postman collection
-mvn -Dfile.encoding=UTF-8 smart-doc: postman
+mvn -Dfile.encoding=UTF-8 smart-doc:postman
+// Generate document and send to Torna
+mvn -Dfile.encoding=UTF-8 smart-doc:torna-rest
 
 // Apache Dubbo RPC
 // Generate html

README_CN.md

@@ -32,6 +32,11 @@ $\color{red}{你给我的star，胜过所有读过的诗—smart-doc}$
 - 支持Maven、Gradle插件式轻松集成。
 - 支持Apache Dubbo RPC接口文档生成。
 - debug接口调试html5页面完全支持文件上传，下载(@download tag标记下载方法)测试。
+
+## Best Practice
+smart-doc + [Torna](http://torna.cn) 组成行业领先的文档生成和管理解决方案，使用smart-doc无侵入完成Java源代码分析和提取注释生成API文档，自动将文档推送到Torna企业级接口文档管理平台。
+
+![smart-doc+torna](http://torna.cn/assets/images/case/smart-doc.png)
 ## Getting Started
 smart-doc使用和测试可参考[smart-doc demo](https://gitee.com/devin-alan/api-doc-test.git)。
 ```
@@ -114,6 +119,12 @@ smart-doc官方目前已经开发完成[Maven插件](https://gitee.com/smart-doc
   "requestExample":"true",//是否将请求示例展示在文档中，默认true，@since 1.9.0
   "responseExample":"true",//是否将响应示例展示在文档中，默认为true，@since 1.9.0
   "displayActualType":false,//配置true会在注释栏自动显示泛型的真实类型短类名，@since 1.9.6
+  "appKey": "xxx",// torna平台对接appKey,, @since 2.0.9
+  "appToken": "xxx", //torna平台appToken,@since 2.0.9
+  "secret": "xx",//torna平台secret，@since 2.0.9
+  "openUrl": "torna server/api/",//torna平台地址，填写自己的私有化部署地址@since 2.0.9
+  "debugEnvName":"测试环境", //torna测试环境
+  "debugEnvUrl":"http://127.0.0.1",//torna
   "ignoreRequestParams":[ //忽略请求参数对象，把不想生成文档的参数对象屏蔽掉，@since 1.9.2
      "org.springframework.ui.ModelMap"
    ],
@@ -189,6 +200,8 @@ mvn -Dfile.encoding=UTF-8 smart-doc:adoc
 mvn -Dfile.encoding=UTF-8 smart-doc:postman
 // 生成 Open Api 3.0+,Since smart-doc-maven-plugin 1.1.5
 mvn -Dfile.encoding=UTF-8 smart-doc:openapi
+// 生成文档推送到Torna平台
+mvn -Dfile.encoding=UTF-8 smart-doc:torna-rest
 
 // Apache Dubbo RPC文档
 // Generate html

pom.xml

@@ -5,7 +5,7 @@
     <modelVersion>4.0.0</modelVersion>
     <artifactId>smart-doc</artifactId>
     <packaging>jar</packaging>
-    <version>2.0.8</version>
+    <version>2.0.9</version>
 
     <name>smart-doc</name>
     <url>https://github.com/smart-doc-group/smart-doc.git</url>