【发布时间】：2016-08-22 09:10:14
【问题描述】：
我有一个 Spring Boot RESTful API，它接受 JSON 作为 POST 操作的请求正文。 JSON 使用 Jackson ObjectMapper 转换为某些对象。随着越来越多的团队使用我们的 API，我们需要有良好的最新文档。我已经将 Swagger 和 Spring REST Docs 视为记录 API 的方法。但是，我没有看到对我的情况有帮助的示例。
我有很多 POJO。它们都继承自一个共同的 POJO，有些具有许多继承链。存在许多不同的 POJO，每个都代表不同的事件。 POJO 具有诸如 @NotNull 之类的注释和其他 ObjectMapper 注释来描述 JSON。我们希望通过代码记录这些 POJO 或模型，以便我们始终拥有与代码同步的文档。 Swagger 对于我们的案例来说似乎太简单了，因为我们的 POST API 接受许多不同的模型，而我什至还没有看到 Spring REST Docs 的在线示例。
所以基本上，我的问题是：我可以通过代码用注释记录我的 POJO 吗？谢谢！
【问题讨论】：
-
不使用注解，但是Spring REST Docs支持documenting request and response payloads和their constraints
-
嗨，Andy，我还没有在线看到 Spring REST Docs 的示例，但我认为它最适合我。您是否知道任何在线运行的 Spring REST 文档示例？
-
REST Docs 本身有several samples。也有几个人在博客上写过它。例如，请参阅 info.michael-simons.eu/2015/11/05/…、yetanotherdevblog.com/introduction_to_spring_restdocs 和 medium.com/@flbenz/…。
标签： spring hibernate spring-boot jackson swagger