spring-mvc Rest api 文档的类似 javadoc 的工具?

发布于 2024-10-04 02:40:14 字数 1459 浏览 5 评论 0原文

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(3

蘑菇王子 2024-10-11 02:40:14

你应该看看 RESTdoclet。 http://ig-group.github.com/RESTdoclet/

You should look at RESTdoclet. http://ig-group.github.com/RESTdoclet/

美男兮 2024-10-11 02:40:14

如果您想自己执行此操作,可以这样处理:

  1. 创建 AnnotationReader 实现扫描各种 @Path 注释
  2. 测试它是否能够读取 name 属性
  3. 创建一个封装此扫描功能的 Maven mojo
  4. 添加该功能以将正则表达式参数(例如 {customerId})映射到对文档目的有意义的内容 - 或许可以通过阅读关联的 Javadoc。

注释阅读器不必对现有注释进行任何修改,因此构建端点正则表达式列表应该很简单。结合 Javadocs,您应该能够创建一个有用的工具。我当然会发现它很有用,也许其他人也会。

If you wanted to do this yourself, you could approach it like this:

  1. Create an AnnotationReader implementation that scans for the various @Path annotations
  2. Test that it is capable of reading the name attribute
  3. Create a Maven mojo that wraps this scanning functionality
  4. Add in the facility to map the regex parameters (e.g. {customerId}) into something meaningful for documentation purposes - perhaps by reading the associated Javadoc.

The annotation reader won't have to do any modifications to the existing annotations so it should be straightforward to build up a list of the endpoint regular expressions. In combination with the Javadocs you should be able to create a useful tool. I'd certainly find it useful, and perhaps others would too.

盛装女皇 2024-10-11 02:40:14

我知道 Enunciate,它与 Jersey/CXF 配合得很好 - 但我不知道是否可以用 SpringMVC 来做。

I know Enunciate, which works pretty well with Jersey/CXF - but I don't know if it does with SpringMVC.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文