update readme
This commit is contained in:
parent
bc737b6f06
commit
40ebd16384
|
@ -1,7 +1,7 @@
|
|||
## smart-doc版本
|
||||
版本小于1.0都属于试用,正式1.0起始发布将会等到文中提到的问题解决后才发布。
|
||||
#### 版本号:1.9.0
|
||||
- 更新日期: 2020-07-2x
|
||||
- 更新日期: 2020-07-19
|
||||
- 更新内容:
|
||||
1. 修改dubbo html依赖部分错乱问题。
|
||||
2. 新增自定义输出文件名称的配置。
|
||||
|
|
|
@ -92,6 +92,9 @@ When you need to use smart-doc to generate more API document information, you ca
|
|||
"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
|
||||
"responseFieldToUnderline":true,//convert response field to underline
|
||||
"allInOneDocFileName":"index.html",//Customize the output document name
|
||||
"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.
|
||||
"dataDictionaries": [// Configure the data dictionary, no need to set
|
||||
{
|
||||
"title": "Order Status", // The name of the data dictionary
|
||||
|
|
|
@ -14,7 +14,7 @@ smart-doc完全基于接口源码分析来生成接口文档,完全做到零
|
|||
- 对一些常用字段定义能够生成有效的模拟值。
|
||||
- 支持生成json返回值示例。
|
||||
- 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。
|
||||
- 支持生成多种格式文档:Markdown、HTML5、Asciidoctor、Postman json。
|
||||
- 支持生成多种格式文档:Markdown、HTML5、Asciidoctor、Postman Collection。
|
||||
- 轻易实现在Spring Boot服务上在线查看静态HTML5 api文档。
|
||||
- 开放文档数据,可自由实现接入文档管理系统。
|
||||
- 支持导出错误码和定义在代码中的各种字典码到接口文档。
|
||||
|
@ -91,6 +91,9 @@ smart-doc官方目前已经开发完成[maven插件](https://gitee.com/sunyurepo
|
|||
"responseFieldToUnderline":true,//自动将驼峰入参字段在文档中转为下划线格式,//@since 1.8.7版本开始
|
||||
"inlineEnum":true,//设置为true会将枚举详情展示到参数表中,默认关闭,//@since 1.8.8版本开始
|
||||
"recursionLimit":7,//设置允许递归执行的次数用于避免一些对象解析卡主,默认是7,正常为3次以内,//@since 1.8.8版本开始
|
||||
"allInOneDocFileName":"index.html",//自定义设置输出文档名称, @since 1.9.0
|
||||
"requestExample":"true",//是否将请求示例展示在文档中,默认true,@since 1.9.0
|
||||
"responseExample":"true",//是否将响应示例展示在文档中,默认为true,@since 1.9.0
|
||||
"dataDictionaries": [ //配置数据字典,没有需求可以不设置
|
||||
{
|
||||
"title": "http状态码字典", //数据字典的名称
|
||||
|
|
12
pom.xml
12
pom.xml
|
@ -5,7 +5,7 @@
|
|||
<modelVersion>4.0.0</modelVersion>
|
||||
<artifactId>smart-doc</artifactId>
|
||||
<packaging>jar</packaging>
|
||||
<version>1.8.9</version>
|
||||
<version>1.9.0</version>
|
||||
|
||||
<name>smart-doc</name>
|
||||
<url>https://github.com/shalousun/smart-doc.git</url>
|
||||
|
@ -32,7 +32,7 @@
|
|||
</developers>
|
||||
<properties>
|
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||
<flexmark.version>0.61.32</flexmark.version>
|
||||
<flexmark.version>0.62.2</flexmark.version>
|
||||
</properties>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
|
@ -44,7 +44,7 @@
|
|||
<dependency>
|
||||
<groupId>com.ibeetl</groupId>
|
||||
<artifactId>beetl</artifactId>
|
||||
<version>3.1.6.RELEASE</version>
|
||||
<version>3.1.8.RELEASE</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.thoughtworks.qdox</groupId>
|
||||
|
@ -55,6 +55,12 @@
|
|||
<groupId>com.github.javafaker</groupId>
|
||||
<artifactId>javafaker</artifactId>
|
||||
<version>1.0.2</version>
|
||||
<exclusions>
|
||||
<exclusion>
|
||||
<artifactId>commons-lang3</artifactId>
|
||||
<groupId>org.apache.commons</groupId>
|
||||
</exclusion>
|
||||
</exclusions>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.github.shalousun</groupId>
|
||||
|
|
Loading…
Reference in New Issue