记录 JSON-RPC 端点

发布于 2024-12-06 09:44:55 字数 244 浏览 0 评论 0原文

我们有一个广泛的 Java API,在我们的服务器上作为 JSON-RPC 端点公开。问题是 API 文档目前必须在 Javadoc 和 JSON-RPC API 中重复。有人知道有一个工具或框架可以自动提取用于 JSON-RPC API 文档的 Javadoc 过程吗?

我们的 JSON-RPC 框架很大程度上是自行开发的。我正在寻找的是任何能让我解析 javadoc 的东西,以便我可以以有意义的方式将 Javadoc 片段包含在我的 API 文档中。

We have an extensive Java API that's exposed as JSON-RPC endpoints on our server. The problem is that the API documentation currently has to be duplicated in Javadoc and JSON-RPC API. Does anybody know of a tool or a framework that can automate the process of extracting Javadoc to be used for a JSON-RPC API documentation?

Our JSON-RPC framework is very much homegrown. What I am looking for is anything that will let me parse the javadocs so that I can include the Javadoc snippets in my API docs in a meaningful way.

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

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

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文