如何从与Google Gson兼容的Java类创建文档或JSON模式?

时间:2013-01-04 04:54:01

标签: json javadoc gson

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

理想情况下,我想要一个生成JSON示例,JSON模式或其他Web开发人员友好文档的JavaDoc工具,可以轻松地与Maven集成,为具有特定注释的类型生成基于HTML的文档

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

此领域是否有相关工具?

1 个答案:

答案 0 :(得分:0)

我过去曾使用过Swagger。它实现起来很简单,但却生成了强大的API文档。

请查看此文档。我认为这就是你要找的东西。

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