swagger - 使用 Spring-Data-Rest 招摇

Question

有没有人用 spring-data-rest 配置招摇。我知道 swagger 有 DocumentationConfig 类，它扫描所有 spring-mvc 请求映射。但是，如何将它用于 spring-data-rest，因为没有定义明确的请求映射。非常感谢这方面的任何帮助。另外，想知道是否有任何其他支持 Spring-Data-Rest 的文档框架。

Answer 1

在大于 2.6.0 的SpringFox版本中，添加了对 spring data rest 的支持（但它仍在孵化中）。为了添加对 Spring Data Rest 的支持，您需要包含以下依赖项：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-data-rest</artifactId>
    <version>2.6.1</version>
</dependency>

Answer 2

这已经存在了一段时间，但正如其他人所提到的，（仍然）没有支持 Spring Data Rest 的 Swagger 实现。但是，Spring Data Rest 确实遵循 HAL 规范，并且HAL 浏览器与任何 SDR 项目真正无缝集成。再加上公开ALPS元数据的较新版本的 SDR，这对于您的文档目标应该是非常足够的。

Answer 3

回答您的第二个问题：AsciiDoctor 结合Spring REST Docs /RestAssured 可以成为记录 SDR 端点的简洁方式。不过，它确实需要一些手动操作，因为唯一的自动化部分将是创建片段。然后可以将这些加载到您的 AsciiDoc 文件中。