Swagger with Spring-Data-Rest

时间:2014-03-12 01:45:03

标签: swagger spring-data-rest

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

3 个答案:

答案 0 :(得分:5)

SpringFox 大于2.6.0的版本中,添加了对spring数据休息的支持(但它仍在孵化中)。为了添加对Spring Data Rest的支持,您需要在下面包含依赖项:

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

答案 1 :(得分:4)

这已经存在了一段时间,但正如其他人所提到的那样,(仍然)没有支持Spring Data Rest的Swagger实现。但是,Spring Data Rest确实遵循HAL规范,HAL Browser与任何SDR项目完全无缝集成。与公开ALPS元数据的较新版SDR结合使用,这对于您的文档目标来说应该足够了。

答案 2 :(得分:0)

回答第二个问题: AsciiDoctor结合Spring REST Docs / RestAssured可以很好地记录SDR端点。它确实需要一些手动工作,因为唯一的自动化部分将是片段的创建。然后可以将它们加载到您的AsciiDoc文件中。