x-easypdf v2.9.3 版本发布,文档上线
x-easypdf基于pdfbox二次封装,极大降低使用门槛,以组件化的形式进行pdf的构建。简单易用,帮助开发者快速生成pdf文档。 本次更新内容如下: 新特性: - 新增设置渲染类型的方法 - 新增开启灰度的方法 - 新增开启透明的方法 - 新增开启水平合并的方法 - 新增开启垂直合并的方法 - 文档上线,地址:https://xsxgit.gitee.io/x-easypdf 原有变更: 无 问题修复: 无
smart-doc 是一款同时支持 java restful api 和 Apache Dubbo rpc 接口文档生成的工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。
smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释编写,smart-doc 就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污染,那请拥抱 smart-doc 吧!
Smart-doc 和其他工具的支持
| 功能特性 | smart-doc | swagger |
| 代码侵入 | 无 | 注解侵入性严重 |
| 集成复杂度 | 简单,只需插件 | 偏复杂 |
| 插件支持 | 有 gradle 和 maven 插件 | 无插件 |
| openapi 规范支持 | 支持 openapi 3.0 | 完全支持 openapi 的版本 |
| CI 构建集成 | 可在 ci 构建阶段使用 maven 或者 gradle 命令 启动插件生成文档
|
不支持 |
| 集中化文档中心集成 | 已经和 torna 企业级接口文档管理平台对接 |
不支持 |
| 维护持续性 | 值得信赖,开源后用户基础多,一直持续维护 | 全球用户多,开源维护值得信赖 |
| 接口 debug | 2.0.0 版本开始已经支持 debug,页面比 swagger 漂亮太多了。 | 支持 |
Smart-doc 从 2.0.0 后几乎实现了 swagger ui 的功能,并且比 swagger ui 更简洁大方,也更符合国内开发者的诉求。当前 smart-doc 的功能也已经
超过了 swagger 为 java 开发者提供的功能。当然 smart-doc 本身是只支持扫描代码生成 openapi 3.0 的文档的,也可以将生成的 openapi 3.0 文档导入到其他 ui 中渲染展示。
最近两年,国内也有不少开发者开发了无侵入 idea 文档生成插件,我们也在持续关注这些插件的发展。目前来讲这些 idea 的插件在集成上肯定比 smart-doc 简单,文档生成速度比 smart-doc 快 (idea 插件没有编译这些阶段),但是目前这些插件都没有解决掉多模块项目以及依赖部模块的场景下中的注释问题,对 smart-doc 发展过程中收集到的用例支持也还不完善。综合看 smart-doc 当前仍然是国内 java web 开发者生成文档的最佳工具。
1. 支持servlet 3.0 文件上传[#294](https://github.com/smart-doc-group/smart-doc/issues/294) 2. 修复表单复杂对象嵌套Request-example错误问题[#284](https://github.com/smart-doc-group/smart-doc/issues/284) 3. 修复注释换行导致html文档链接无法点击问题[#290](https://github.com/smart-doc-group/smart-doc/issues/290) 4. 修复实现接口的枚举作为字段时生成文档报错,[#292](https://github.com/smart-doc-group/smart-doc/issues/292) 5. 修复Delete Option json请求没有request body的问题[#300](https://github.com/smart-doc-group/smart-doc/issues/300) 6. 修复OpenAPI导出一级菜单未使用注释名的bug,[#296](https://github.com/smart-doc-group/smart-doc/issues/296) 7. 新增对JAX-RS @PATCH、@HEAD 的支持[#pr303](https://github.com/smart-doc-group/smart-doc/pull/303) 8. 自增serverEnv配置用户支持在postman中设置服务器地址变量,[#280](https://github.com/smart-doc-group/smart-doc/issues/280)
smart-doc 官方为了方便用户快速和无侵入的集成 smart-doc 的文档 api 生成能力,我们开发可相关的 maven 或者 gradle 插件。这里也推荐使用插件的方式来使用 smart-doc。
https://gitee.com/smart-doc-team/smart-doc-maven-plugin
smart-doc + Torna 组成行业领先的文档生成和管理解决方案,使用 smart-doc 无侵入完成 Java 源代码分析和提取注释生成 API 文档,自动将文档推送到 Torna 企业级接口文档管理平台。
smart-doc 在国内很多企业中被用来替换了 swagger,甚至是在国内 Top 3 内的大厂都有 smart-doc 的二次开发版本。Torna 未来的目标是追赶和超越 Yapi。smart-doc 针对 java spring 技术栈的解析能力目前为业内最强 (不服就拿工具来跑 smart-doc 的解析 demo)。所以 smart-doc+Torna 的方案威力巨大,Torna 目前处于高速迭代期,欢迎体验 Torna,我们努力为社区提供高效好用的接口文档解决方案。
smart-doc 可基于以前的版本平滑升级。
使用 demo 轻松玩转接口文档生成,其他用户案例文档效果展示:https://api.doubans.com/
在 2021 年 8 月 smart-doc 也新增了一些外海的用户。
微信关注我们
转载内容版权归作者及来源网站所有!
低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。
马里奥是站在游戏界顶峰的超人气多面角色。马里奥靠吃蘑菇成长,特征是大鼻子、头戴帽子、身穿背带裤,还留着胡子。与他的双胞胎兄弟路易基一起,长年担任任天堂的招牌角色。
为解决软件依赖安装时官方源访问速度慢的问题,腾讯云为一些软件搭建了缓存服务。您可以通过使用腾讯云软件源站来提升依赖包的安装速度。为了方便用户自由搭建服务架构,目前腾讯云软件源站支持公网访问和内网访问。
Spring框架(Spring Framework)是由Rod Johnson于2002年提出的开源Java企业级应用框架,旨在通过使用JavaBean替代传统EJB实现方式降低企业级编程开发的复杂性。该框架基于简单性、可测试性和松耦合性设计理念,提供核心容器、应用上下文、数据访问集成等模块,支持整合Hibernate、Struts等第三方框架,其适用范围不仅限于服务器端开发,绝大多数Java应用均可从中受益。
Sublime Text具有漂亮的用户界面和强大的功能,例如代码缩略图,Python的插件,代码段等。还可自定义键绑定,菜单和工具栏。Sublime Text 的主要功能包括:拼写检查,书签,完整的 Python API , Goto 功能,即时项目切换,多选择,多窗口等等。Sublime Text 是一个跨平台的编辑器,同时支持Windows、Linux、Mac OS X等操作系统。