Java   发布时间:2022-04-02  发布网站:大佬教程  code.js-code.com
大佬教程收集整理的这篇文章主要介绍了还在用 Swagger?试试这款神器,功能真心强大!大佬教程大佬觉得挺不错的,现在分享给大家,也给大家做个参考。

介绍

smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-doc在业内率先提出基于JAVA泛型定义推导的理念,完全基于接口源码来分析生成接口文档,不采用任何注解侵入到业务代码中。

你只需要按照java-doc标准编写注释, smart-doc就能帮你生成一个简易明了的Markdown、HTML5、Postman、Collection2.0+、OpenAPI 3.0+的文档。

目前使用者

    @H_450_13@科大讯飞 @H_450_13@小米 @H_450_13@一加 @H_450_13@顺丰

特点

    @H_450_13@零注解、零学习成本、只需要写标准JAVA注释。 @H_450_13@基于源代码接口定义自动推导,强大的返回结构推导。 @H_450_13@支持Spring MVC、Spring Boot、Spring Boot Web Flux(controller书写方式)、Feign。 @H_450_13@支持Callable、Future、CompletableFuture等异步接口返回的推导。 @H_450_13@支持JavaBean上的JSR303参数校验规范,包括分组验证。 @H_450_13@对JSON请求参数的接口能够自动生成模拟JSON参数。 @H_450_13@对一些常用字段定义能够生成有效的模拟值。 @H_450_13@支持生成JSON返回值示例。 @H_450_13@支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。 @H_450_13@支持生成多种格式文档:Markdown、HTML5、Asciidoctor、Postman Collection、OpenAPI 3.0。Up- 开放文档数据,可自由实现接入文档管理系统。 @H_450_13@支持导出错误码和定义在代码中的各种字典码到接口文档。 @H_450_13@支持Maven、Gradle插件式轻松集成。 @H_450_13@支持Apache Dubbo RPC接口文档生成。 @H_450_13@debug接口调试html5页面完全支持文件上传,下载(@download tag标记下载方法)测试。

smart-doc 从 2.0.0 后几乎实现了 swagger ui 的功能,并且比 swagger ui 更简洁大方,也更符合国内开发者的诉求。

当然 smart-doc 本身是只支持扫描代码生成 openapi 3.0 的文档的,也可以将生成的 openapi 3.0 文档导入到其他ui中渲染展示。

效果示例

1.1 接口文档效果图

输入图片说明

请求参数示例

响应参数示例

1.2 html全局效果

更多了解,开源地址:https://gitee.com/smart-doc-team

近期热文推荐:

1.1,000+ 道 Java面试题及答案整理(2021最新版)

2.别在再满屏的 if/ else 了,试试策略模式,真香!!

3.卧槽!Java 中的 xx ≠ null 是什么新语法?

4.Spring Boot 2.5 重磅发布,黑暗模式太炸了!

5.《Java开发手册(嵩山版)》最新发布,速速下载!

觉得不错,别忘了随手点赞+转发哦!

大佬总结

以上是大佬教程为你收集整理的还在用 Swagger?试试这款神器,功能真心强大!全部内容,希望文章能够帮你解决还在用 Swagger?试试这款神器,功能真心强大!所遇到的程序开发问题。

如果觉得大佬教程网站内容还不错,欢迎将大佬教程推荐给程序员好友。

本图文内容来源于网友网络收集整理提供,作为学习参考使用,版权属于原作者。
如您有任何意见或建议可联系处理。小编QQ:384754419,请注明来意。
标签: