共计 512 个字符,预计需要花费 2 分钟才能阅读完成。
smart-doc 是一款同时支持 JAVA REST API 和 Apache Dubbo RPC 接口文档生成的工具,smart-doc 利用接口泛型和 javadoc 注释自动分析生成 api 接口文档,不采用任何注解侵入到业务代码中。只需要在项目中引入 smart-doc 提供的 maven 或者是 gradle 插件,然后按照规范写好 javadoc 注释即可生成 api 文档。同时 smart-doc 也支持生成 openapi 和 postman 这些规范的文档,生成后可以直接导入相关工具做测试。
目前在国内已被小米、科大讯飞、同程旅行、快手、马蜂窝、顺丰等知名公司所使用。
仓库地址
https://github.com/TongchengOpenSource/smart-doc
重要更新内容
- 添加 gRPC 接口文档生成支持
- 完善 Java WebSocket 文档类型和 Message 请求的支持
- 添加对
@JsonView
的支持
社区贡献
smart-doc 作为同程旅行大力支持的开源项目,对于社区贡献的 committer,我们将提供书籍、文化衫等礼品作为奖励,非常欢迎社区用户参与共建。后续社区也会逐步增加其他语言的支持。
未来计划
新增对其它开发语言的支持(欢迎开发者加入参与社区共建)
正文完