Update CHANGELOG.md
This commit is contained in:
parent
87b4694cac
commit
061238fb93
15
CHANGELOG.md
15
CHANGELOG.md
|
@ -1,12 +1,23 @@
|
|||
## smart-doc版本
|
||||
版本小于1.0都属于试用,正式1.0起始发布将会等到文中提到的问题解决后才发布。
|
||||
#### 版本号:2.1.3
|
||||
- 更新日期: 2020-04-09
|
||||
- 更新内容:
|
||||
1. 增强对文件上传的支持。
|
||||
2. 增加customRequestFields配置项,#97。
|
||||
3. 修复往torna推送漏掉pathParams的问题。
|
||||
#### 版本号:2.1.2
|
||||
- 更新日期: 2020-03-29
|
||||
- 更新内容:
|
||||
1. 修复Map嵌套在某些结构体中栈溢出问题,gitee #I3CCLY。
|
||||
2. 修复Torna数据推送问题。
|
||||
#### 版本号:2.1.1
|
||||
- 更新日期: 2020-03-31
|
||||
- 更新日期: 2020-03-24
|
||||
- 更新内容:
|
||||
1. 修复Map嵌套在某些结构体中栈溢出问题,gitee #I3CCLY。
|
||||
2. 修复Torna数据推送问题。
|
||||
#### 版本号:2.1.0
|
||||
- 更新日期: 2020-03-31
|
||||
- 更新日期: 2020-03-21
|
||||
- 更新内容:
|
||||
1. 导出的postman的url资源下添加缺失的protocol。
|
||||
2. 增加@ignoreParams自定义tag来过滤掉不想显示在文档中参数。
|
||||
|
|
|
@ -146,6 +146,14 @@ When you need to use smart-doc to generate more API document information, you ca
|
|||
"desc": "Response code", // Override field comment of response code
|
||||
"value": "00000" // Set the value of the response code
|
||||
}],
|
||||
"customRequestFields":[{
|
||||
"name":"code", //Override the request code field
|
||||
"desc":"request code", //Override field comment of response code
|
||||
"ownerClassName":"com.xxx.constant.entity.Result",
|
||||
"value":"200", // Set the value of the response code
|
||||
"required":true,
|
||||
"ignore":false
|
||||
}],
|
||||
"apiObjectReplacements": [{ // Supports replacing specified objects with custom objects to complete document rendering
|
||||
"className": "org.springframework.data.domain.Pageable",
|
||||
"replacementClassName": "com.power.doc.model.PageRequestDto" //Use custom PageRequestDto instead of JPA Pageable for document rendering.
|
||||
|
|
11
README_CN.md
11
README_CN.md
|
@ -26,8 +26,7 @@ $\color{red}{你给我的star,胜过所有读过的诗—smart-doc}$
|
|||
- 支持生成JSON返回值示例。
|
||||
- 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。
|
||||
- 支持生成多种格式文档:Markdown、HTML5、Asciidoctor、Postman Collection、OpenAPI 3.0。
|
||||
- 轻易实现在Spring Boot服务上在线查看静态HTML5 api文档,支持生成在线debug页面。
|
||||
- 开放文档数据,可自由实现接入文档管理系统。
|
||||
Up- 开放文档数据,可自由实现接入文档管理系统。
|
||||
- 支持导出错误码和定义在代码中的各种字典码到接口文档。
|
||||
- 支持Maven、Gradle插件式轻松集成。
|
||||
- 支持Apache Dubbo RPC接口文档生成。
|
||||
|
@ -158,6 +157,14 @@ smart-doc官方目前已经开发完成[Maven插件](https://gitee.com/smart-doc
|
|||
"ownerClassName": "org.springframework.data.domain.Pageable", //指定你要添加注释的类名
|
||||
"value": "00000"//设置响应码的值
|
||||
}],
|
||||
"customRequestFields": [{
|
||||
"name":"code", //属性名
|
||||
"desc":"状态码", //描述
|
||||
"ownerClassName":"com.xxx.constant.entity.Result", //属性对应的类全路径
|
||||
"value":"200", //默认值或者mock值
|
||||
"required":true, //是否必填
|
||||
"ignore":false //是否忽略
|
||||
}],
|
||||
"requestHeaders": [{ //设置请求头,没有需求可以不设置
|
||||
"name": "token",//请求头名称
|
||||
"type": "string",//请求头类型
|
||||
|
|
|
@ -1,3 +1,25 @@
|
|||
/*
|
||||
* smart-doc
|
||||
*
|
||||
* Copyright (C) 2018-2021 smart-doc
|
||||
*
|
||||
* Licensed to the Apache Software Foundation (ASF) under one
|
||||
* or more contributor license agreements. See the NOTICE file
|
||||
* distributed with this work for additional information
|
||||
* regarding copyright ownership. The ASF licenses this file
|
||||
* to you under the Apache License, Version 2.0 (the
|
||||
* "License"); you may not use this file except in compliance
|
||||
* with the License. You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
* KIND, either express or implied. See the License for the
|
||||
* specific language governing permissions and limitations
|
||||
* under the License.
|
||||
*/
|
||||
package com.power.doc.model;
|
||||
|
||||
/**
|
||||
|
|
Loading…
Reference in New Issue