专栏首页小维博客一款零注解侵入的 API 文档生成工具,你用过吗?

一款零注解侵入的 API 文档生成工具,你用过吗?

一款零注解侵入的 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 从 2.0.0 后几乎实现了 swagger ui 的功能,并且比 swagger ui 更简洁大方,也更符合国内开发者的诉求。

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


效果示例

1. 接口文档效果图

输入图片说明

请求参数示例

响应参数示例

2. HTML全局效果

html文档


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

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 一款零注解侵入的 API 文档生成工具,你用过吗?

    smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-doc在业内率先提出基于JAVA泛型...

    好好学java
  • 一款零注解API接口文档生成工具

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

    lyb-geek
  • 推荐一款 Java 零注解 API 文档生成工具

    smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释编写,smart-doc 就能帮你生成一个简易明了的...

    肉眼品世界
  • 扔掉Swagger,试试这款功能强大,零注解侵入的API接口文档生成工具!

    smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-doc在业内率先提出基于JAVA泛型...

    Java团长
  • 扔掉Swagger,试试这款功能强大,零注解侵入的API接口文档生成工具!

    smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-doc在业内率先提出基于JAVA泛型...

    乔戈里
  • 作为一个java开发者我为什么不用Swagger

    Swagger号称是最好的Rest Api 文件生成工具,但是作为一个一直从事java相关开发工作的开发者。在2018年6月以前一直坚持用Markdown来手写...

    用户1218746
  • 干货分享|推荐几个超赞的在线文档生成工具,终于可以告别word时代了

    最近公司打算做一个openapi开放平台,让我找一款好用的在线文档生成工具,具体要求如下:

    苏三说技术
  • 求你别再用swagger了,给你推荐几个在线文档生成神器

    最近公司打算做一个openapi开放平台,让我找一款好用的在线文档生成工具,具体要求如下:

    苏三说技术
  • 支持 Dubbo 接口文档生成的工具

    smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-doc在业内率先提出基于JAVA泛型...

    JAVA葵花宝典
  • 支持Dubbo接口文档生成的工具!

    smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-doc在业内率先提出基于JAVA泛型...

    路人甲Java
  • 基于SpringCloud的Microservices架构实战案例-在线API管理

    前端和后端的唯一联系,变成了API接口;API文档变成了前后端开发人员联系的纽带,变得越来越重要,swagger就是一款让你更好的书写API文档的框架。 本实战...

    MavenTalker
  • 快速学习-Smart-Doc Project 基于JAVA-REST和dubbo的API接口文档

    smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-doc在业内率先提出基于JAVA泛型...

    cwl_java
  • Adobe Flash零日漏洞(CVE-2018-4878)在野攻击完全分析报告

    背景 2018年1月31日,韩国计算机应急响应小组发布了一则关于Adobe Flash Player的 0day 漏洞警告,并称早在2017年11月中旬,就有黑...

    FB客服
  • ApiBoot:《SpringBoot》整合组件接口服务框架落地解决方案

    ApiBoot是一款基于SpringBoot2.x的接口服务集成基础框架,内部提供了框架的封装集成,让接口开发者完成开箱即用,不再为搭建接口框架而犯愁,从而极大...

    恒宇少年
  • 老司机出品——数据持久化之基于FMDB的ORM数据库设计

    这次呢,我们来说说iOS中数据持久化的几种方案。说到iOS中的数据存储,无非有4中方式:

    老司机Wicky
  • 《HelloGitHub》第 40 期

    这是一个面向编程新手、热爱编程、对开源社区感兴趣 人群的月刊,月刊的内容包括:各种编程语言的项目、让生活变得更美好的工具、书籍、学习笔记、教程等,这些开源项目大...

    HelloGitHub
  • 不想用 Swagger?可以试试这个神器!

    在《芋道 Spring Boot API 接口文档 Swagger 入门》一文中,我们一起学习了如何使用 Swagger 生成接口文档。但是狗芳嫌弃需要在 Co...

    芋道源码
  • 小程序99问

    A:微信支付商户申请填写结算账户时如果找不到所在的银行,请选择“其他银行”后手动填写所在支行全称,例如:建设银行佛山市环市支行。

    微盛企微管家
  • 《HelloGitHub》第 41 期

    这是一个面向编程新手、热爱编程、对开源社区感兴趣 人群的月刊,月刊的内容包括:各种编程语言的项目、让生活变得更美好的工具、书籍、学习笔记、教程等,这些开源项目大...

    HelloGitHub

扫码关注云+社区

领取腾讯云代金券