用于将JSON插入JavaDoc的工具？

Question

我正在使用MireDot为我的REST服务生成文档。

虽然生成有关资源的模型和一般信息非常棒，但我不相信它目前有一种“很好地”添加具体示例输入/输出的方法。

那就是说，我正在使用纯JavaDoc来编写Json示例。这很痛苦。

有没有人知道有哪些工具可以帮助编写JavaDoc ...特别是可以很容易地将格式化的JSON / etc插入其中？

Answer 1

这是我在尝试记录API的方法时发布的一个老问题。

最终我通过MireDot切换到Apiary，这使得这项任务变得微不足道。这种转换的原因主要是将JavaDoc与实际的API文档分离，因为我发现这两者的耦合可能会为需要大量文档的复杂API创建一个非常混乱的代码库。

理想情况下，可以使用像Mashery之类的全方位API管理平台构建文档，但当时不是一种选择。