smart-doc 1.9.5 发布,Java 零注解 API 文档生成工具

栏目: 软件资讯 · 发布时间: 1个月前

来源: 开源中国社区

内容简介:smart-doc是一款同时支持java restful api和apache dubbo rpc接口文档生成的工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档,完...

本文转载自:https://www.oschina.net/news/118754/smart-doc-1-9-5-released,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有。

smart-doc是一款同时支持java restful api和apache dubbo rpc接口文档生成的工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释编写,smart-doc就能帮你生成一个简易明了的markdown 或是一个像GitBook样式的静态 html 文档。如果你已经厌倦了swagger等文档 工具 的无数注解和强侵入污染,那请拥抱smart-doc吧!

功能特性

  • 零注解、零学习成本、只需要写标准java注释。
  • 基于源代码接口定义自动推导,强大的返回结构推导。
  • 支持Spring MVC,Spring Boot,Spring Boot Web Flux(controller书写方式)。
  • 支持Callable,Future,CompletableFuture等异步接口返回的推导。
  • 支持JavaBean上的JSR303参数校验规范,支持分组验证。
  • json 请求参数的接口能够自动生成模拟json参数。
  • 对一些常用字段定义能够生成有效的模拟值。
  • 支持生成json返回值示例。
  • 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。
  • 支持生成多种格式文档:Markdown、 HTML5 、Asciidoctor、Postman collection、Open Api 3.0+。
  • 轻易实现在Spring Boot服务上在线查看静态HTML5 api文档。
  • 开放文档数据,可自由实现接入文档管理系统。
  • 一款代码注释检测工具,不写注释的小伙伴逃不过法眼了。
  • 插件式快速集成(支持maven和gradle插件)。
  • 支持apache dubbo rpc文档生成。

Smart-doc vs Swagger

  •  smart-doc不是对Swagger造轮子,这是一款用完全不同的理念重新开发的restful api接口文档生成工具。
  •  smart-doc比swagger集成更简单,可以自由生成多种格式的api文档。
  •  smart-doc完全不需要在侵入到业务代码中写任何注解,插件化集成到项目。
  •  smart-doc提供了许多swagger没有 的功能,例如:字典码、业务错误码导出到文档,dubbo rpc接口文档生成。
  • smart-doc完全支持swagger指定的标准open api 3.0+规范。
  • smart-doc对于企业来说提供了比swagger更多的扩拓展能力,例如用smart-doc开放的数据自己开发生成性能测试脚本等。

更新内容

1.修改一些特殊注释导致html页面错误。
2.controller接口不带注解的参数将required值改为false。

maven或gradle插件

smart-doc官方为了方便用户快速和无侵入的集成smart-doc的文档api生成能力,我们开发可相关的maven或者gradle插件。这里也推荐使用插件的方式来使用smart-doc。

https://gitee.com/smart-doc-team/smart-doc-maven-plugin

升级建议

   修复了用户反馈的一些bug,本次升级不涉及到api的变更,可以平滑升级。

DEMO

使用demo轻松玩转接口文档生成,其他用户案例文档效果展示:https://api.doubans.com/

知名用户

  • 科大讯飞
  • 一加
  • 小米

以上所述就是小编给大家介绍的《smart-doc 1.9.5 发布,Java 零注解 API 文档生成工具》,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对 码农网 的支持!

关注码农网公众号

关注我们,获取更多IT资讯^_^


为你推荐:

相关软件推荐:

查看所有标签

本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们

JavaScript快速开发工具箱

JavaScript快速开发工具箱

Robin Nixon / 陈武、姚飞 / 清华大学出版社 / 2011-11 / 59.00元

《JavaScript快速开发工具箱:轻松解决JavaScript日常编程问题的100个插件工具》通透讲解100个现成的JavaScript插件,引导您使用这些利器得心应手地创建动态Web内容。《JavaScript快速开发工具箱:轻松解决JavaScript日常编程问题的100个插件工具》开篇讲解JavaScript、CSS和DOM,此后每章都列举一个完整示例,指导您将特定效果快速应用于网页。使......一起来看看 《JavaScript快速开发工具箱》 这本书的介绍吧!

CSS 压缩/解压工具
CSS 压缩/解压工具

在线压缩/解压 CSS 代码

UNIX 时间戳转换
UNIX 时间戳转换

UNIX 时间戳转换

HSV CMYK 转换工具
HSV CMYK 转换工具

HSV CMYK互换工具