千磨万击还坚劲,任尔东西南北风。这篇文章主要讲述扔掉Swagger,试试这款功能强大,零注解侵入的API接口文档生成工具!相关的知识,希望能为你提供帮助。
优质文章,第一时间送达
大家好,我是燕子!
介绍【扔掉Swagger,试试这款功能强大,零注解侵入的API接口文档生成工具!】smart-doc是一款同时支持java REST API和Apache Dubbo RPC接口文档生成的工具,smart-doc在业内率先提出基于JAVA泛型定义推导的理念,完全基于接口源码来分析生成接口文档,不采用任何注解侵入到业务代码中。
你只需要按照java-doc标准编写注释, smart-doc就能帮你生成一个简易明了的Markdown、html5、Postman、Collection2.0+、OpenAPI 3.0+的文档。
目前使用者
- 科大讯飞
- 小米
- 一加
- 顺丰
特点
- 零注解、零学习成本、只需要写标准JAVA注释。
- 基于源代码接口定义自动推导,强大的返回结构推导。
- 支持Spring MVC、Spring Boot、Spring Boot Web Flux(controller书写方式)、Feign。
- 支持Callable、Future、CompletableFuture等异步接口返回的推导。
- 支持JavaBean上的JSR303参数校验规范,包括分组验证。
- 对JSON请求参数的接口能够自动生成模拟JSON参数。
- 对一些常用字段定义能够生成有效的模拟值。
- 支持生成JSON返回值示例。
- 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。
- 支持生成多种格式文档:Markdown、HTML5、Asciidoctor、Postman Collection、OpenAPI 3.0。Up- 开放文档数据,可自由实现接入文档管理系统。
- 支持导出错误码和定义在代码中的各种字典码到接口文档。
- 支持Maven、Gradle插件式轻松集成。
- 支持Apache Dubbo RPC接口文档生成。
- debug接口调试html5页面完全支持文件上传,下载(@download tag标记下载方法)测试。
当然 smart-doc 本身是只支持扫描代码生成 openapi 3.0 的文档的,也可以将生成的 openapi 3.0 文档导入到其他ui中渲染展示。
效果示例1.1 接口文档效果图
文章图片
输入图片说明
文章图片
请求参数示例??
文章图片
??响应参数示例
1.2 html全局效果
文章图片
html文档
更多了解,开源地址:https://gitee.com/smart-doc-team
- ?
推荐阅读
- zabbix
- 在 Linux 终端使用 inxi 命令获取各种系统信息
- #yyds干货盘点#linux命令--grep
- 如何快速建立一个podman环境
- #yyds干货盘点# 「MQ」五分钟带你了解什么是消息队列()
- JavaScript错误处理try..catch...finally,涵盖throw,TypeError,RangeError#yyds干货盘点#
- #yyds干货盘点#Spring源码三千问Spring动态代理(什么时候使用的 cglib,什么时候使用的是 jdk proxy())
- 重重封锁,让你一条数据都拿不到《死磕MySQL系列 十三》
- #私藏项目实操分享#Python模拟登录,selenium模块,Python识别图形验证码实现自动登录