V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
smartdoc647
V2EX  ›  程序员

smart-doc 支持 dubbo rpc 文档的生成了

  •  
  •   smartdoc647 · 2020-06-03 10:14:23 +08:00 · 1036 次点击
    这是一个创建于 1423 天前的主题,其中的信息可能已经有所发展或是发生改变。

    smart-doc 是一款同时支持 java restful 和 apache dubbo rpc 接口文档生成的工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释编写,smart-doc 就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污染,那请拥抱 smart-doc 吧!

    功能特性

    • 零注解、零学习成本、只需要写标准 java 注释。
    • 基于源代码接口定义自动推导,强大的返回结构推导。
    • 支持 Spring MVC,Spring Boot,Spring Boot Web Flux(controller 书写方式)。
    • 支持 Callable,Future,CompletableFuture 等异步接口返回的推导。
    • 支持 JavaBean 上的 JSR303 参数校验规范,支持分组验证。
    • 对 json 请求参数的接口能够自动生成模拟 json 参数。
    • 支持生成 json 返回值示例。
    • 支持从项目外部加载源代码来生成字段注释。
    • 支持生成多种格式文档:Markdown 、HTML5 、Postman collection 。
    • 插件式快速集成,文档齐全,官方提供了 21 个文档。
    • 支持 apache dubbo rpc

    项目仓库

    smart-doc 的码云仓库链接

    github 仓库地址链接

    smart-doc 的部分知名用户

    • 科大讯飞
    • 小米
    • 一加
    目前尚无回复
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   3657 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 23ms · UTC 10:29 · PVG 18:29 · LAX 03:29 · JFK 06:29
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.