Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lkqm committed Sep 9, 2022
1 parent fb7e8ba commit 3e6949d
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 11 deletions.
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,15 @@
**一键生成API接口文档, 上传到YApi, Rap2, Eolinker等平台的IDEA插件.**

**亮点**
- 零成本、零入侵: 编写标准Javadoc即可,无需依赖swagger注解, 生成文档准确性高达99%
- 开箱即用、智能mock规则: 几乎零配置直接可生成文档,也支持复杂配置满足你95%的场景
- 多平台支持:支持YApi, Rap2, Eolinker等,并支持账户密码登录
- 零成本: 支持主流框架、编写标准Javadoc就可以生成很好的API文档
- 智能规则: 内置mock规则,可以生成很好的Mock数据
- 交互友好: 支持账户密码登录,单方法、单类、多类、整个项目上传接口文档

**特性**
- [x] 一键从源代码生成api文档
- [x] 上传到YApi平台
- [x] 上传到Rap2平台
- [x] 上传到Eolinker平台
- [x] 上传到ShowDoc平台
- [x] 导出markdown文件
- [x] 复制为cURL命令

- [x] 上传文档YApi、Rap2、Eolinker、ShowDoc平台
- [x] 导出文档OpenAPI、Markdown、cURL格式
- [x] 支持主流框架Spring MVC、Spring Flux、Jackson、JSR303、Swagger注解

<img src="docs/screenshots.gif" height="360">

Expand Down
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ dependencies {

// See https://github.com/JetBrains/gradle-intellij-plugin/
intellij {
version = '2019.3'
version = '2021.3'
sandboxDir = "${project.rootDir}/.sandbox"
updateSinceUntilBuild = false
plugins = ['java', 'properties']
Expand Down
4 changes: 4 additions & 0 deletions src/main/resources/META-INF/plugin.xml
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,10 @@
</actions>

<change-notes><![CDATA[
0.9.7: <br>
- feat: 支持导出为OpenApi3.0<br>
- fix: 修复无法上传Eolinker问题<br>
<br>
0.9.6: <br>
- feat: 支持自定义@RequestBody注解<br>
- fix: 修复无法上传Eolinker问题<br>
Expand Down

0 comments on commit 3e6949d

Please sign in to comment.