zoukankan      html  css  js  c++  java
  • 还在用 Swagger?试试这款神器,功能真心强大!

    介绍

    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.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开发手册(嵩山版)》最新发布,速速下载!

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

  • 相关阅读:
    SpringMVC框架搭建
    java事务的概念
    SpringMVC框架
    JAVA多线程面试题
    MD5加密
    java对象和xml的转换
    eclipse环境配置
    关于枚举类的使用
    定时器的使用
    关于AS-OS
  • 原文地址:https://www.cnblogs.com/javastack/p/15439919.html
Copyright © 2011-2022 走看看