我们可以使用 Spring rest 文档记录模型/实体吗

问题描述

使用代码段描述写入所有字段不是可靠的解决方案 有什么方法可以将模型/实体实现为具有字段和描述、约束、类型的表格。

---

fieldWithPath("id").description("Id of Student."),fieldWithPath("name").description("Name of the Student."),fieldWithPath("contact").description("Contact of the Student."),fieldWithPath("marks").description("Marks of the Student."));

解决方法

直接记录实体正是 Spring REST Docs 旨在避免的。如果这是您想要采用的方法，那么 Spring REST Docs 不是适合该工作的工具。

Spring REST Docs 建立在这样一种信念之上：在记录 REST API 时，应该使用 HTTP 请求和响应来生成该文档。这可确保文档准确描述服务期望接收的请求以及将发送的响应。

如果您尝试使用实体来记录您的 API，那么您将忽略在将其序列化为 JSON 时可以应用于该实体的转换。这可能会导致文档不准确，因为序列化可能会忽略实体的某些属性、更改其中某些属性的名称，甚至完全更改结构。