太原Java培训
达内太原java培训中心

18035108441

热门课程

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

  • 时间:2019-12-03 09:54
  • 发布:开源中国
  • 来源:开源中国

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

smart-doc是一个java restful api文档生成工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释的写,smart-doc就能帮你生成一个简易明了的Markdown、Html、AsciiDoc文档,当然还支持生成直接导入Postman的接口json文档。

如果你已经厌倦了swagger等文档工具的无数注解和强侵入污染,那请拥抱smart-doc吧!喜欢smart-doc的用户也不要忘记给项目star,你们的支持是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 json。

轻易实现在Spring Boot服务上在线查看静态HTML5 api文档。

开放文档数据,可自由实现接入文档管理系统。

一款代码注释检测工具,不写注释的小伙伴逃不过法眼了。

支持导出错误码和定义在代码中的各种枚举字典到接口文档。

Smart-doc vs Swagger

smart-doc不是对Swagger造轮子,这是一款用完全不同的理念重新开发的restful api接口文档生成工具。

smart-doc比swagger集成更简单,可以自由生成多种格式的api文档。

smart-doc完全不需要在侵入到业务代码中写任何注解,复杂嵌套对象自动推导出定义字段结构。

smart-doc代码量很少,如果不能满足你的需求完全可以自己修改源码定制(当前有数十家企业基于smart-doc强大的源码分析能力做二次修改内部使用)。

更新内容

修改Spring Controller使用非Spring Web注解时生成的响应示例出错的bug。

修改使用mybatis-plus实体继承Model对象时将log字段输出到文档的问题。

html文档添加项目名称显示。

修改github #4泛型中Void类型解析死循环。

修改github #5简单枚举参数解析空指针异常。

重要新功能:Smart-doc支持生成Postman json接口测试数据,一键导入Postman即可测试接口。

DEMO

使用demo只有smart-doc能够自己分析出完善文档的demo

相关文档

关于java web restful api文档的重新探索

smart-doc功能使用介绍

项目官方wiki (完善的文档和使用介绍)

用户评价

部分使用者对smart-doc的评价

最强大的doc组件,强制要求了规范,也不会污染代码,欣喜之情溢于言表!

smartdoc从注释入手,即规范强化了文档的编写又能提供源码文档之外的api功能,真的对得起smart的称谓。

开源贡献者招揽:

Smart-doc完全由个人开发者主导,随着Smart-doc不断的被很多企业所采用,维护工作变得越来越多,因此这里非常希望想贡献的开发者加入,

更多人一起把Smart-doc做成更好用的Java Restful Api文档生成工具。

java编程语言从创建一直延续到现在,始终是大多数程序员追捧的编程语言之一。对于java语言的适应性以及实用性是不言而喻的。因此,IT的小白大部分也就选择了java编程的培训课程。太原java培训从基础开始授课,结合项目实操练习。学习java编程培训就到达内java培训班,免费试听课程,感受java带给你的独特魅力。

【免责声明】本文系本网编辑部分转载,转载目的在于传递更多信息,并不代表本网赞同其观点和对其真实性负责。如涉及作品内容、版权和其它问题,请在30日内与管理员联系,我们会予以更改或删除相关文章,以保证您的权益!

预约申请免费试听课程

         

上一篇:Java零基础培训之java架构师就业
下一篇:Apache HBase 1.4.12 发布,分布式数据库

微软开源安全工具 Application Inspector

BudWk 6.0.1 Alpha 发布,Java 微服务分布式开发框架

2020年学习java程序员的就业薪资怎么样?

Mac版微信拓展功能开源工具WeChatExtension

选择城市和中心
江西省

贵州省

广西省

海南省