5

我目前正在实现一组旨在供 JavaScript 客户端使用的 Web 服务,并且正在使用 Google Gson 进行 JSON 序列化/反序列化。因此,我的服务合同是在 Java 类中定义的。我现在需要一种方法来生成这些消息接口的文档,以供 JavaScript 开发人员使用。

理想情况下,我想要一个类似于 JavaDoc 的工具,它可以生成我的类型的 JSON 示例、JSON 模式或其他对 Web 开发人员友好的文档,这些工具可以很容易地与 Maven 集成,从而为具有特定注释的类型生成基于 HTML 的文档。

我可以将它们指向生成的 JavaDoc,但它需要他们理解并搜索所有私有字段以找出如何格式化请求,并且也不考虑 Gson 类型转换器等。

该领域是否有任何相关工具可用?

4

1 回答 1

0

我过去使用过 Swagger。它易于实现,但生成强大的 API 文档。

请查看此文档。我想这就是你要找的。

http://petstore.swagger.wordnik.com/

于 2014-12-23T07:48:59.497 回答