一款零注解API接口文档生成工具

沙海 2021年6月24日01:11:54Java评论22字数 1766阅读5分53秒阅读模式
摘要

一款零注解API接口文档生成工具 点击关注 ? 芋道源码

一款零注解API接口文档生成工具

点击关注 ? 芋道源码 文章源自JAVA秀-https://www.javaxiu.com/34821.html

收录于话题文章源自JAVA秀-https://www.javaxiu.com/34821.html

#芋道源码文章源自JAVA秀-https://www.javaxiu.com/34821.html

148个文章源自JAVA秀-https://www.javaxiu.com/34821.html

点击上方“芋道源码”,选择“设为星标文章源自JAVA秀-https://www.javaxiu.com/34821.html

管她前浪,还是后浪?文章源自JAVA秀-https://www.javaxiu.com/34821.html

能浪的浪,才是好浪!文章源自JAVA秀-https://www.javaxiu.com/34821.html

每天 8:55 更新文章,每天掉亿点点头发...文章源自JAVA秀-https://www.javaxiu.com/34821.html

文章源自JAVA秀-https://www.javaxiu.com/34821.html

源码精品专栏文章源自JAVA秀-https://www.javaxiu.com/34821.html

 文章源自JAVA秀-https://www.javaxiu.com/34821.html

文章源自JAVA秀-https://www.javaxiu.com/34821.html

文章源自JAVA秀-https://www.javaxiu.com/34821.html

smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,基于接口源码来分析生成接口文档,不采用任何注解侵入到业务代码中。只需要按照java-doc标准编写注释,smart-doc就能帮你生成一个简易明了的Markdown,或是一个像GitBook样式的静态html文档、以及Postman Collection2.0+、OpenAPI 3.0+的文档。文章源自JAVA秀-https://www.javaxiu.com/34821.html

一款零注解API接口文档生成工具文章源自JAVA秀-https://www.javaxiu.com/34821.html

图片文章源自JAVA秀-https://www.javaxiu.com/34821.html

一改传统类似swagger这种大量采用注解侵入来生成文档的实现方法。文章源自JAVA秀-https://www.javaxiu.com/34821.html

主要功能特性

  • 支持接口Debug。文章源自JAVA秀-https://www.javaxiu.com/34821.html

  • 零注解、零学习成本、只需要写标准JAVA注释。文章源自JAVA秀-https://www.javaxiu.com/34821.html

  • 基于源代码接口定义自动推导,强大的返回结构推导。文章源自JAVA秀-https://www.javaxiu.com/34821.html

  • 支持Spring MVC、Spring Boot、Spring Boot Web Flux(controller书写方式)、Feign。文章源自JAVA秀-https://www.javaxiu.com/34821.html

  • 支持Callable、Future、CompletableFuture等异步接口返回的推导。文章源自JAVA秀-https://www.javaxiu.com/34821.html

  • 支持JavaBean上的JSR303参数校验规范,包括分组验证。文章源自JAVA秀-https://www.javaxiu.com/34821.html

  • 对JSON请求参数的接口能够自动生成模拟JSON参数。文章源自JAVA秀-https://www.javaxiu.com/34821.html

  • 对一些常用字段定义能够生成有效的模拟值。文章源自JAVA秀-https://www.javaxiu.com/34821.html

  • 支持生成JSON返回值示例。文章源自JAVA秀-https://www.javaxiu.com/34821.html

  • 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的 jar 包)。文章源自JAVA秀-https://www.javaxiu.com/34821.html

  • 支持生成多种格式文档:Markdown、HTML5、Asciidoctor、Postman collection、Open Api 3.0+。文章源自JAVA秀-https://www.javaxiu.com/34821.html

  • 轻易实现在 Spring Boot 服务上在线查看静态 HTML5 api 文档。文章源自JAVA秀-https://www.javaxiu.com/34821.html

  • 支持Maven、Gradle插件式轻松集成。文章源自JAVA秀-https://www.javaxiu.com/34821.html

  • 支持 Apache Dubbo rpc 文档生成。文章源自JAVA秀-https://www.javaxiu.com/34821.html

smart-doc从2.0.0后几乎实现了swagger ui的功能,并且比swagger ui更简洁大方,也更符合国内开发者的诉求。当然smart-doc的功能也已经 超过了Swagger为Java开发者提供的功能。文章源自JAVA秀-https://www.javaxiu.com/34821.html

使用形式

Maven插件形式

一款零注解API接口文档生成工具文章源自JAVA秀-https://www.javaxiu.com/34821.html

图片文章源自JAVA秀-https://www.javaxiu.com/34821.html

Gradle插件形式

一款零注解API接口文档生成工具文章源自JAVA秀-https://www.javaxiu.com/34821.html

图片文章源自JAVA秀-https://www.javaxiu.com/34821.html

使用效果

一款零注解API接口文档生成工具文章源自JAVA秀-https://www.javaxiu.com/34821.html

图片文章源自JAVA秀-https://www.javaxiu.com/34821.html

一款零注解API接口文档生成工具文章源自JAVA秀-https://www.javaxiu.com/34821.html

图片文章源自JAVA秀-https://www.javaxiu.com/34821.html

一款零注解API接口文档生成工具文章源自JAVA秀-https://www.javaxiu.com/34821.html

图片文章源自JAVA秀-https://www.javaxiu.com/34821.html

一款零注解API接口文档生成工具文章源自JAVA秀-https://www.javaxiu.com/34821.html

图片文章源自JAVA秀-https://www.javaxiu.com/34821.html

源码和文档地址

源码,具体详细使用方式以及Demo可参考:https://gitee.com/smart-doc-team/smart-doc文章源自JAVA秀-https://www.javaxiu.com/34821.html

  • 《芋道 Spring Boot API 接口调试 IDEA HTTP Client 》:https://www.iocoder.cn/Spring-Boot/IDEA-HTTP-Client/文章源自JAVA秀-https://www.javaxiu.com/34821.html

  • 《芋道 Spring Boot API 接口文档 JApiDocs 入门 》:https://www.iocoder.cn/Spring-Boot/JApiDocs/文章源自JAVA秀-https://www.javaxiu.com/34821.html

  • 《芋道 Spring Boot API 接口文档 Swagger 入门 》:https://www.iocoder.cn/Spring-Boot/Swagger/文章源自JAVA秀-https://www.javaxiu.com/34821.html

- END -文章源自JAVA秀-https://www.javaxiu.com/34821.html

欢迎加入我的知识星球,一起探讨架构,交流源码。加入方式,长按下方二维码噢文章源自JAVA秀-https://www.javaxiu.com/34821.html

一款零注解API接口文档生成工具文章源自JAVA秀-https://www.javaxiu.com/34821.html

已在知识星球更新源码解析如下:文章源自JAVA秀-https://www.javaxiu.com/34821.html

一款零注解API接口文档生成工具文章源自JAVA秀-https://www.javaxiu.com/34821.html

一款零注解API接口文档生成工具文章源自JAVA秀-https://www.javaxiu.com/34821.html

一款零注解API接口文档生成工具文章源自JAVA秀-https://www.javaxiu.com/34821.html

一款零注解API接口文档生成工具文章源自JAVA秀-https://www.javaxiu.com/34821.html

最近更新《芋道 SpringBoot 2.X 入门》系列,已经 20 余篇,覆盖了 MyBatis、Redis、MongoDB、ES、分库分表、读写分离、SpringMVC、Webflux、权限、WebSocket、Dubbo、RabbitMQ、RocketMQ、Kafka、性能测试等等内容。文章源自JAVA秀-https://www.javaxiu.com/34821.html

提供近 3W 行代码的 SpringBoot 示例,以及超 4W 行代码的电商微服务项目。文章源自JAVA秀-https://www.javaxiu.com/34821.html

获取方式:点“在看”,关注公众号并回复 666 领取,更多内容陆续奉上。文章源自JAVA秀-https://www.javaxiu.com/34821.html

文章源自JAVA秀-https://www.javaxiu.com/34821.html

文章有帮助的话,在看,转发吧。谢谢支持哟 (*^__^*)
文章源自JAVA秀-https://www.javaxiu.com/34821.html

阅读原文文章源自JAVA秀-https://www.javaxiu.com/34821.html

继续阅读
速蛙云 - 极致体验,强烈推荐!!!购买套餐就免费送各大视频网站会员!快速稳定、独家福利社、流媒体稳定解锁!速度快,全球上网、视频、游戏加速、独立IP均支持!基础套餐性价比很高!这里不多说,我一直正在使用,推荐购买:https://www.javaxiu.com/59919.html
weinxin
资源分享QQ群
本站是JAVA秀团队的技术分享社区, 会经常分享资源和教程; 分享的时代, 请别再沉默!
沙海
匿名

发表评论

匿名网友 填写信息

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen:

确定