Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ body:
or are unsure if this is really a bug, make sure to:

- Read the [docs](https://smart-doc-group.github.io/)
- Ask on [GitHub Discussions](https://github.com/TongchengOpenSource/smart-doc/discussions)
- Ask on [GitHub Discussions](https://github.com/smart-doc-group/smart-doc/discussions)
- If you use the version is not the latest version, please upgrade to the latest version and try again!


Expand All @@ -29,7 +29,7 @@ body:

- 请采用<mark style="background-color: yellow;">英文</mark>填写,包括issue标题,不符合要求会被关闭和清理。
- 阅读 [文档](https://smart-doc-group.github.io/)
- 在 [GitHub Discussions](https://github.com/TongchengOpenSource/smart-doc/discussions) 上询问
- 在 [GitHub Discussions](https://github.com/smart-doc-group/smart-doc/discussions) 上询问
- 如果您使用的版本不是最新版本,请升级到最新版本后再试!


Expand Down Expand Up @@ -130,7 +130,7 @@ body:
label: Validations
description: Before submitting the issue, please make sure you do the following (在提交问题之前,请确保执行以下操作)
options:
- label: Check if you're on the [latest smart-doc version](https://github.com/TongchengOpenSource/smart-doc/releases/latest). (请检查是否为最新版本)
- label: Check if you're on the [latest smart-doc version](https://github.com/smart-doc-group/smart-doc/releases/latest). (请检查是否为最新版本)
required: true
- label: Read the [docs](https://smart-doc-group.github.io/). (请先阅读官方文档)
required: true
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/build-and-run-example-project.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ jobs:
- name: Checkout Maven Plugin Repository
uses: actions/checkout@v5
with:
repository: TongchengOpenSource/smart-doc-maven-plugin
repository: smart-doc-group/smart-doc-maven-plugin
token: ${{ secrets.GITHUB_TOKEN }}

- name: Set up JDK 8
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/deploy-to-maven-central.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:

jobs:
deploy:
if: ${{ github.repository == 'TongchengOpenSource/smart-doc' }}
if: ${{ github.repository == 'smart-doc-group/smart-doc' }}
runs-on: ubuntu-latest

steps:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/maven.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ on:

jobs:
build:
if: ${{ github.repository == 'TongchengOpenSource/smart-doc' }}
if: ${{ github.repository == 'smart-doc-group/smart-doc' }}
runs-on: ubuntu-latest

steps:
Expand Down
102 changes: 51 additions & 51 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,74 +4,74 @@

- 更新日期: 2024-3-30
- 更新内容:
1. 新功能::sparkles: 添加 WebSocket 支持并更新许可证有效期。[#752](https://github.com/TongchengOpenSource/smart-doc/pull/752)
2. 修复 #746:为枚举值添加分隔符。[#754](https://github.com/TongchengOpenSource/smart-doc/pull/754)
3. 新功能:优化 JSR 验证信息的提取。[#755](https://github.com/TongchengOpenSource/smart-doc/pull/755)
4. 在参数中添加扩展以支持 openapi..[#759](https://github.com/TongchengOpenSource/smart-doc/pull/759)
5. 修复泛型 typeName 或 returnType 的错误。[#761](https://github.com/TongchengOpenSource/smart-doc/pull/761)
6. 修复 Solon 框架中的非接口文档问题。[#765](https://github.com/TongchengOpenSource/smart-doc/pull/765)
7. 修复 Javadoc 标签使用错误的提示。[#767](https://github.com/TongchengOpenSource/smart-doc/pull/767)
8. Solon 已弃用 PathVar 并替换为 Path。[#765](https://github.com/TongchengOpenSource/smart-doc/pull/765)
9. 优化 Javadoc 标签使用错误的提示。[#767](https://github.com/TongchengOpenSource/smart-doc/pull/767)
10. 修复 Solon 框架中非接口文档的问题。[#771](https://github.com/TongchengOpenSource/smart-doc/pull/771)
11. 更新:修复 null 参数值中多余的双引号问题。[#772](https://github.com/TongchengOpenSource/smart-doc/pull/772)
12. 新功能:支持 RPC 中多级接口继承。[#773](https://github.com/TongchengOpenSource/smart-doc/pull/773)
13. 新功能:在添加自定义注解到参数后,忽略集合参数检查。[#774](https://github.com/TongchengOpenSource/smart-doc/pull/774)
14. 新功能:忽略集合参数检查。[#775](https://github.com/TongchengOpenSource/smart-doc/pull/775)
1. 新功能::sparkles: 添加 WebSocket 支持并更新许可证有效期。[#752](https://github.com/smart-doc-group/smart-doc/pull/752)
2. 修复 #746:为枚举值添加分隔符。[#754](https://github.com/smart-doc-group/smart-doc/pull/754)
3. 新功能:优化 JSR 验证信息的提取。[#755](https://github.com/smart-doc-group/smart-doc/pull/755)
4. 在参数中添加扩展以支持 openapi..[#759](https://github.com/smart-doc-group/smart-doc/pull/759)
5. 修复泛型 typeName 或 returnType 的错误。[#761](https://github.com/smart-doc-group/smart-doc/pull/761)
6. 修复 Solon 框架中的非接口文档问题。[#765](https://github.com/smart-doc-group/smart-doc/pull/765)
7. 修复 Javadoc 标签使用错误的提示。[#767](https://github.com/smart-doc-group/smart-doc/pull/767)
8. Solon 已弃用 PathVar 并替换为 Path。[#765](https://github.com/smart-doc-group/smart-doc/pull/765)
9. 优化 Javadoc 标签使用错误的提示。[#767](https://github.com/smart-doc-group/smart-doc/pull/767)
10. 修复 Solon 框架中非接口文档的问题。[#771](https://github.com/smart-doc-group/smart-doc/pull/771)
11. 更新:修复 null 参数值中多余的双引号问题。[#772](https://github.com/smart-doc-group/smart-doc/pull/772)
12. 新功能:支持 RPC 中多级接口继承。[#773](https://github.com/smart-doc-group/smart-doc/pull/773)
13. 新功能:在添加自定义注解到参数后,忽略集合参数检查。[#774](https://github.com/smart-doc-group/smart-doc/pull/774)
14. 新功能:忽略集合参数检查。[#775](https://github.com/smart-doc-group/smart-doc/pull/775)

### 版本号:3.0.2
- 更新日期: 2024-2-26
- 更新内容:
1. 优化推送rpc文档到torna时smart-doc设置的框架名错误,[#690](https://github.com/smart-doc-group/smart-doc/issues/690)
2. 修复html文档搜索后链接错误的bug,[#693](https://github.com/smart-doc-group/smart-doc/pull/693)
3. 支持分批上传文档到torna[#697](https://github.com/TongchengOpenSource/smart-doc/issues/697)
4. 修复mock中值双引号被删除的问题[#680](https://github.com/TongchengOpenSource/smart-doc/issues/680)
5. 支持提取java record的注释[#703](https://github.com/TongchengOpenSource/smart-doc/pull/703)
6. 修复报错信息错误[#706](https://github.com/TongchengOpenSource/smart-doc/pull/706)
7. 优化第三方库枚举缺失导致生成文档被中断的问题[#707](https://github.com/TongchengOpenSource/smart-doc/pull/707)
8. 重构优化word模版,生成的文档更漂亮 [#710](https://github.com/TongchengOpenSource/smart-doc/pull/710)
9. 修复创建word文档错误的问题[#711](https://github.com/TongchengOpenSource/smart-doc/pull/711)
10. 修复html特殊元素导致生成的jmeter无法打开的bug [#713](https://github.com/TongchengOpenSource/smart-doc/pull/713)
11. 支持@JsonSerialize(using = ToStringSerializer.class)字段类型的处理。 [#715](https://github.com/TongchengOpenSource/smart-doc/pull/715)
12. 修复openApi生成的tags与paths未对packageFilters进行过滤。 [#716](https://github.com/TongchengOpenSource/smart-doc/pull/716)
13. 修复项目采用git初始化未提交时生成文档报错bug。 [#719](https://github.com/TongchengOpenSource/smart-doc/issue/719)
14. 忽略NoClassDefFoundError错误,避免第三方代码存在问题时影响文档生成。 [#724](https://github.com/TongchengOpenSource/smart-doc/issue/724)
15. 修复gradle插件codePath未设置导致使用报错的问题。 [gradle #15](https://github.com/TongchengOpenSource/smart-doc-gradle-plugin/pull/15)
16. 优化常量获取,兼容更多用户可以在路径中使用各种常量。[#730](https://github.com/TongchengOpenSource/smart-doc/pull/730)
17. 修改高版本smart-doc生成JAX-RS规范项目文档报错问题。[#729](https://github.com/TongchengOpenSource/smart-doc/pull/729)
18. 修复内部枚举类作为参数时无法正常解析的问题。[#728](https://github.com/TongchengOpenSource/smart-doc/pull/728)
19. 修复void返回时返回用例生成错误。[#726](https://github.com/TongchengOpenSource/smart-doc/pull/726)
20. 修改JAX-RS绑定集合入参报错问题。 [#735](https://github.com/TongchengOpenSource/smart-doc/pull/735)
21. 新增类级别的接口排除过滤。[#736](https://github.com/TongchengOpenSource/smart-doc/pull/736)
22. openapi枚举类型增加取值范围展示[#741](https://github.com/TongchengOpenSource/smart-doc/pull/741)
3. 支持分批上传文档到torna[#697](https://github.com/smart-doc-group/smart-doc/issues/697)
4. 修复mock中值双引号被删除的问题[#680](https://github.com/smart-doc-group/smart-doc/issues/680)
5. 支持提取java record的注释[#703](https://github.com/smart-doc-group/smart-doc/pull/703)
6. 修复报错信息错误[#706](https://github.com/smart-doc-group/smart-doc/pull/706)
7. 优化第三方库枚举缺失导致生成文档被中断的问题[#707](https://github.com/smart-doc-group/smart-doc/pull/707)
8. 重构优化word模版,生成的文档更漂亮 [#710](https://github.com/smart-doc-group/smart-doc/pull/710)
9. 修复创建word文档错误的问题[#711](https://github.com/smart-doc-group/smart-doc/pull/711)
10. 修复html特殊元素导致生成的jmeter无法打开的bug [#713](https://github.com/smart-doc-group/smart-doc/pull/713)
11. 支持@JsonSerialize(using = ToStringSerializer.class)字段类型的处理。 [#715](https://github.com/smart-doc-group/smart-doc/pull/715)
12. 修复openApi生成的tags与paths未对packageFilters进行过滤。 [#716](https://github.com/smart-doc-group/smart-doc/pull/716)
13. 修复项目采用git初始化未提交时生成文档报错bug。 [#719](https://github.com/smart-doc-group/smart-doc/issue/719)
14. 忽略NoClassDefFoundError错误,避免第三方代码存在问题时影响文档生成。 [#724](https://github.com/smart-doc-group/smart-doc/issue/724)
15. 修复gradle插件codePath未设置导致使用报错的问题。 [gradle #15](https://github.com/smart-doc-group/smart-doc-gradle-plugin/pull/15)
16. 优化常量获取,兼容更多用户可以在路径中使用各种常量。[#730](https://github.com/smart-doc-group/smart-doc/pull/730)
17. 修改高版本smart-doc生成JAX-RS规范项目文档报错问题。[#729](https://github.com/smart-doc-group/smart-doc/pull/729)
18. 修复内部枚举类作为参数时无法正常解析的问题。[#728](https://github.com/smart-doc-group/smart-doc/pull/728)
19. 修复void返回时返回用例生成错误。[#726](https://github.com/smart-doc-group/smart-doc/pull/726)
20. 修改JAX-RS绑定集合入参报错问题。 [#735](https://github.com/smart-doc-group/smart-doc/pull/735)
21. 新增类级别的接口排除过滤。[#736](https://github.com/smart-doc-group/smart-doc/pull/736)
22. openapi枚举类型增加取值范围展示[#741](https://github.com/smart-doc-group/smart-doc/pull/741)

### 版本号:3.0.1
- 更新日期: 2023-12-17
- 更新内容:
1. 优化Dubbo文档设置,[#649](https://github.com/smart-doc-group/smart-doc/issues/649)
2. 优化Dubbo文档中字段类型展示,[#648](https://github.com/smart-doc-group/smart-doc/issues/648)
3. 支持获取接口上RequestMapping[#681](https://github.com/TongchengOpenSource/smart-doc/issues/681)
4. 优化html模版页面url策略方便分享[#658](https://github.com/TongchengOpenSource/smart-doc/issues/658)
5. 支持jmeter性能测试[#653](https://github.com/TongchengOpenSource/smart-doc/issues/653)
6. 支持导入文档到word中[#686](https://github.com/TongchengOpenSource/smart-doc/pull/686)
7. 支持多路由场景下的openapi生成[#679](https://github.com/TongchengOpenSource/smart-doc/pull/679)
8. 兼容swagger的tag [#674](https://github.com/TongchengOpenSource/smart-doc/pull/674)
9. 修复componentType配置为NORMAL失效的问题[#665](https://github.com/TongchengOpenSource/smart-doc/pull/665)
10. 支持基于git管理的增量文档构建[#657](https://github.com/TongchengOpenSource/smart-doc/pull/657)
3. 支持获取接口上RequestMapping[#681](https://github.com/smart-doc-group/smart-doc/issues/681)
4. 优化html模版页面url策略方便分享[#658](https://github.com/smart-doc-group/smart-doc/issues/658)
5. 支持jmeter性能测试[#653](https://github.com/smart-doc-group/smart-doc/issues/653)
6. 支持导入文档到word中[#686](https://github.com/smart-doc-group/smart-doc/pull/686)
7. 支持多路由场景下的openapi生成[#679](https://github.com/smart-doc-group/smart-doc/pull/679)
8. 兼容swagger的tag [#674](https://github.com/smart-doc-group/smart-doc/pull/674)
9. 修复componentType配置为NORMAL失效的问题[#665](https://github.com/smart-doc-group/smart-doc/pull/665)
10. 支持基于git管理的增量文档构建[#657](https://github.com/smart-doc-group/smart-doc/pull/657)

### 版本号:3.0.0
- 更新日期: 2023-10-20
- 更新内容:
1. 修复Java 16+版本反射获取字段是jdk中的类时异常。 [#615](https://github.com/smart-doc-group/smart-doc/issues/615)
2. 修复枚举字典显示错乱问题,维持代码中编写的顺序。[#603](https://github.com/TongchengOpenSource/smart-doc/issues/603)
3. 支持获取接口的注释,[#573](https://github.com/TongchengOpenSource/smart-doc/pull/573)
4. 生成html页面支持多文件上传。[#594](https://github.com/TongchengOpenSource/smart-doc/issues/594)
5. 无参请求生成时生成的OpenAPI文档错误。[#616](https://github.com/TongchengOpenSource/smart-doc/issues/616)
6. 扫描文档时丢弃对JDK原生类型的反射,避免高版本JDK反射时报错。[pr#621](https://github.com/TongchengOpenSource/smart-doc/pull/621)
7. 修复生成postman collection后导入到postman缺少file文件参数问题。[#622](https://github.com/TongchengOpenSource/smart-doc/issues/622)
8. 修复配置ResponseBodyAdvice后torna推送数据错误问题。[#599](https://github.com/TongchengOpenSource/smart-doc/issues/599)
9. 修复customResponseFields无法忽略字段的bug。 [#625](https://github.com/TongchengOpenSource/smart-doc/issues/625)
10. 修复请求参数标记@Null注解时字段没被忽略的bug。[#608](https://github.com/TongchengOpenSource/smart-doc/issues/608)
2. 修复枚举字典显示错乱问题,维持代码中编写的顺序。[#603](https://github.com/smart-doc-group/smart-doc/issues/603)
3. 支持获取接口的注释,[#573](https://github.com/smart-doc-group/smart-doc/pull/573)
4. 生成html页面支持多文件上传。[#594](https://github.com/smart-doc-group/smart-doc/issues/594)
5. 无参请求生成时生成的OpenAPI文档错误。[#616](https://github.com/smart-doc-group/smart-doc/issues/616)
6. 扫描文档时丢弃对JDK原生类型的反射,避免高版本JDK反射时报错。[pr#621](https://github.com/smart-doc-group/smart-doc/pull/621)
7. 修复生成postman collection后导入到postman缺少file文件参数问题。[#622](https://github.com/smart-doc-group/smart-doc/issues/622)
8. 修复配置ResponseBodyAdvice后torna推送数据错误问题。[#599](https://github.com/smart-doc-group/smart-doc/issues/599)
9. 修复customResponseFields无法忽略字段的bug。 [#625](https://github.com/smart-doc-group/smart-doc/issues/625)
10. 修复请求参数标记@Null注解时字段没被忽略的bug。[#608](https://github.com/smart-doc-group/smart-doc/issues/608)


### 版本号:2.7.7
Expand Down
4 changes: 2 additions & 2 deletions NOTICE
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
smart-doc
Copyright 2018-2023 smart-doc
Copyright 2018-2025 smart-doc

This product includes software developed at
The Tongcheng Open Source (http://www.ly.com).
The Smart-Doc Open Source

-----------------------------------------------------------------------
This product contains code from the jackson-databind Project:
Expand Down
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,7 @@ file for details.

## Contact

Email: opensource@ly.com
Email: 836575280@qq.com

Twitter:https://x.com/shalousun

## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=TongchengOpenSource/smart-doc&type=Date)](https://star-history.com/#TongchengOpenSource/smart-doc&Date)
2 changes: 0 additions & 2 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,5 +126,3 @@ height="200px"/>

<img src="https://gitee.com/smart-doc-team/smart-doc/raw/master/images/WeChat-Official-Account.png" style="width: 50%; height: 50%" />

## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=TongchengOpenSource/smart-doc&type=Date)](https://star-history.com/#TongchengOpenSource/smart-doc&Date)
12 changes: 6 additions & 6 deletions pom.xml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

<groupId>com.ly.smart-doc</groupId>
<groupId>com.github.shalousun</groupId>
<modelVersion>4.0.0</modelVersion>
<artifactId>smart-doc</artifactId>
<packaging>jar</packaging>
<version>3.1.2</version>
<version>4.0.0</version>

<name>smart-doc</name>
<url>https://github.com/TongchengOpenSource/smart-doc.git</url>
<url>https://github.com/smart-doc-group/smart-doc.git</url>
<description>Smart-doc is a tool that supports both JAVA RESTFUL API and Apache Dubbo RPC interface document
generation.
</description>
Expand All @@ -21,9 +21,9 @@
</license>
</licenses>
<scm>
<url>https://github.com/TongchengOpenSource/smart-doc.git</url>
<connection>scm:https://github.com/TongchengOpenSource/smart-doc.git</connection>
<developerConnection>scm:https://github.com/TongchengOpenSource/smart-doc.git</developerConnection>
<url>https://github.com/smart-doc-group/smart-doc.git</url>
<connection>scm:https://github.com/smart-doc-group/smart-doc.git</connection>
<developerConnection>scm:https://github.com/smart-doc-group/smart-doc.git</developerConnection>
</scm>
<developers>
<developer>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@
* specific language governing permissions and limitations
* under the License.
*/
package com.ly.doc.builder;
package io.github.smartdoc.builder;

import com.ly.doc.constants.DocGlobalConstants;
import com.ly.doc.factory.BuildTemplateFactory;
import com.ly.doc.helper.JavaProjectBuilderHelper;
import com.ly.doc.model.ApiConfig;
import com.ly.doc.model.ApiDoc;
import com.ly.doc.template.IDocBuildTemplate;
import io.github.smartdoc.constants.DocGlobalConstants;
import io.github.smartdoc.factory.BuildTemplateFactory;
import io.github.smartdoc.helper.JavaProjectBuilderHelper;
import io.github.smartdoc.model.ApiConfig;
import io.github.smartdoc.model.ApiDoc;
import io.github.smartdoc.template.IDocBuildTemplate;
import com.thoughtworks.qdox.JavaProjectBuilder;

import java.util.List;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@
* specific language governing permissions and limitations
* under the License.
*/
package com.ly.doc.builder;
package io.github.smartdoc.builder;

import com.ly.doc.helper.JavaProjectBuilderHelper;
import com.ly.doc.model.ApiAllData;
import com.ly.doc.model.ApiConfig;
import io.github.smartdoc.helper.JavaProjectBuilderHelper;
import io.github.smartdoc.model.ApiAllData;
import io.github.smartdoc.model.ApiConfig;
import com.thoughtworks.qdox.JavaProjectBuilder;

/**
Expand Down
Loading
Loading