【问题标题】:How can I create documentation or a JSON schema from Java classes compatible with Google Gson?如何从与 Google Gson 兼容的 Java 类创建文档或 JSON 模式?
【发布时间】:2013-01-04 04:54:00
【问题描述】:

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

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

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

这方面有没有相关的工具可用?

【问题讨论】:

  • 嗨,我也面临同样的问题。有结果吗?

标签: json javadoc gson


【解决方案1】:

我过去使用过 Swagger。实现简单,但生成强大的 API 文档。

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

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

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2016-06-29
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多