smart-doc 1.8.2 发布 Java 零侵入 API 文档生成工具

2020-03-16 09:28:39 +08:00
 smartdoc647

smart-doc 是一个 java restful api 文档生成工具,smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要写上 java 的标准注释,smart-doc 就能帮你生成一个简易明了的 Markdown、Html、AsciiDoc 文档和 Postman collection 一键导入的测试数据。如果你不喜欢其他工具强侵入的注解污染,smart-doc 给你一个不错的选择!喜欢 smart-doc 的用户也不要忘记给项目 star,你们的支持是 smart-doc 持续推进的动力。smart-doc 目前已经收录到开源中国。

功能特性

项目仓库

smart-doc 的码云仓库链接

github 仓库地址链接

更新内容

  1. 修改 gitee #I19IYW。
  2. 修改文档模板中的 title 设置错误。
  3. 修改 gitee #I191EO
  4. 支持 @Validated 分组

升级建议

本次主要修改了一些 bug 和增加对分组的支持。欢迎升级,推荐直接使用 smart-doc-maven-plugin 插件。

DEMO

使用 demo 轻松玩转接口文档生成

相关文档

smart-doc 文档 wiki

smart-doc 的部分用户

排名不分先后

1792 次点击
所在节点    程序员
2 条回复
leaybc
2020-03-16 18:19:47 +08:00
不错,看到我司有部门在用了。回头可以在项目中引进一下。
hantsy
2020-03-16 19:59:31 +08:00
这个不叫 0 入侵吧。

如果是喜欢编程式的生成文档的话,Spring 的 restdocs 不是更好的选择,所有 API 文档基于真正的测试代码,第一点可以证明文档是可靠性,还可以从测试中取样。

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/653149

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX