使用Javax批註和Hibernate驗證記錄POJO的代碼

我有一個Spring Boot RESTful API，它接受JSON作爲POST操作的請求主體。使用Jackson ObjectMapper將JSON轉換爲某些對象。隨着更多團隊使用我們的API，我們需要擁有最新的良好文檔。我已經將Swagger和Spring REST Docs看作是記錄API的方式。但是，我沒有看到有助於我的情況的例子。使用Javax批註和Hibernate驗證記錄POJO的代碼

我有很多POJO的。他們都是從一個普通的POJO繼承而來，有些擁有許多繼承鏈。存在許多不同的POJO，每個都代表不同的事件。 POJO的註釋類似@NotNull和其他ObjectMapper註釋來描述JSON。我們希望通過代碼記錄這些POJO或模型，以便我們始終擁有代碼當前的文檔。 Swagger對於我們的案例來說似乎過於簡單，因爲我們的POST API接受了許多不同的模型，而且我還沒有看到Spring REST Docs的在線示例。

所以基本上，我的問題是：我可以通過代碼記錄我的POJO的註釋嗎？謝謝！

來源

2016-04-27 PhillipAMann

它不使用註釋，但Spring REST Docs支持[記錄請求和響應有效載荷]（http://docs.spring.io/spring-restdocs/docs/current/reference/html5/#documenting-您的api-request-response-payloads）和[它們的限制]（http://docs.spring.io/spring-restdocs/docs/current/reference/html5/#documenting-your-api-constraints） –

Hi Andy ，我還沒有在網上看到Spring REST Docs的例子，但我認爲它是最適合我的。你知道在線的Spring REST Docs的任何例子嗎？ – PhillipAMann

REST Docs本身有[多個示例]（https://github.com/spring-projects/spring-restdocs/tree/master/samples）。有幾個人也對此進行了博客。請參閱http://info.michael-simons.eu/2015/11/05/documenting-your-api-with-spring-rest-docs/，http：//yetanotherdevblog.com/introduction_to_spring_restdocs和https：//媒體.com/@ flbenz/beautiful-api-documentation-with-negligible-overhead-2ba523205f61＃.fvvhjp6v0例如。 –

看一看JSONDoc： http://jsondoc.org

我用它在我的Spring項目，這是真棒！

來源

2016-04-28 10:53:29

對於Spring Docs或更多對抗Swagger 2，它會更好/更糟糕嗎？ – kensai

使用Javax批註和Hibernate驗證記錄POJO的代碼

回答

相關問題