使用Javax注释和Hibernate验证通过代码记录POJO

时间:2016-04-27 20:44:32

标签: spring hibernate spring-boot jackson swagger

我有一个Spring Boot RESTful API,它接受JSON作为POST操作的请求主体。使用Jackson ObjectMapper将JSON转换为某些对象。随着越来越多的团队使用我们的API,我们需要拥有最新的文档。我已经看到Swagger和Spring REST Docs作为记录API的方法。但是,我没有看到一个对我的情况有帮助的例子。

我有很多POJO。它们都是从一个共同的POJO继承而有些有许多继承链。存在许多不同的POJO,每个POJO代表不同的事件。 POJO有@NotNull和其他ObjectMapper注释之类的注释来描述JSON。我们希望通过代码记录这些POJO或模型,以便我们始终拥有代码最新的文档。对于我们的案例,Swagger似乎过于简单,因为我们的POST API接受了许多不同的模型,我甚至还没有看到Spring REST Docs的在线示例。

所以基本上,我的问题是:我可以通过代码记录我的POJO注释吗?谢谢!

1 个答案:

答案 0 :(得分:1)

看看JSONDoc: http://jsondoc.org

我在我的Spring项目中使用它并且非常棒!