Spring Boot-Spring数据REST从存储库生成swagger文档

Question

我在Spring Boot中有一个带有Spring Data Rest的应用程序，我正在尝试使用Swagger maven插件生成带有Swagger的文档。生成控制器文档时没有问题，但存储库没有问题。

我已经在pom中配置了如下形式的swagger maven插件。xml:

                <plugin>
                <groupId>com.github.kongchen</groupId>
                <artifactId>swagger-maven-plugin</artifactId>
                <version>3.1.6</version>
                <configuration>
                    <apiSources>
                      <apiSource>
                            <springmvc>true</springmvc>
                            <locations>
                                <location>com.abelendo.repository</location>
                                <location>com.abelendo.controller</location>
                            </locations>
                            <schemes>http</schemes>
                            <host>localhost:8080</host>
                            <basePath>/</basePath>
                            <info>
                                <title>Swagger Maven Plugin Spring Boot for cars</title>
                                <version>v1</version>
                                <description>Working sample of Spring Boot for cars annotations</description>
                                <termsOfService>
                                    http://www.github.com
                                </termsOfService>
                                <contact>
                                    <email>[e-mail]</email>
                                    <name>Abelendo Cars</name>
                                    <url>http</url>
                                </contact>
                                <license>
                                    <url>http://www.license.com</url>
                                    <name>License name</name>
                                </license>
                            </info>
                            <!-- Support classpath or file absolute path here.
                            1) classpath e.g: "classpath:/markdown.hbs", "classpath:/templates/hello.html"
                            2) file e.g: "${basedir}/src/main/resources/markdown.hbs",
                                "${basedir}/src/main/resources/template/hello.html" -->
                            <templatePath>${basedir}/templates/strapdown.html.hbs</templatePath>
                            <outputPath>${basedir}/generated/document.html</outputPath>
                            <outputFormats>yaml</outputFormats>
                            <swaggerApiReader>com.github.kongchen.swagger.docgen.reader.SpringMvcApiReader</swaggerApiReader>
                            <swaggerDirectory>generated/swagger-ui</swaggerDirectory>
                        </apiSource>
                    </apiSources>
                </configuration>
                <executions>
                    <execution>
                        <phase>compile</phase>
                        <goals>
                            <goal>generate</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>

我的随身携带物品：

@Api(tags = "CarsRepo")
@RepositoryRestResource(path = "cars")
public interface CarRepository extends CrudRepository<Car, Long> {

<S extends Car> S save(@Valid S cars);

}

是否可以用swagger-maven-plugin生成存储库留档？

Answer 1

我在pom中只有1个依赖项。xml

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-data-rest -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-data-rest</artifactId>
        <version>3.0.0</version>
    </dependency>

然后导入@导入（SpringDataRestConfiguration.class）在资源库中

并生成文档

Answer 2

为了为@RepositoryRestResources生成swagger留档，您需要做的就是：

1. 拔掉木卫一。springfox：项目中的springfox数据rest依赖关系

@Configuration
@EnableSwagger2
@Import(SpringDataRestConfiguration.class)
public class SwaggerConfig {

  @Bean
  public Docket api() { ... }

}

编辑：swagger配置类不适用于spring boot 2.0、spring data 2.0和spring data rest 3.0：swagger中存在一个公开问题（链接到swagger不是Java8，而spring boot和spring data是Java8）。详情请参见此处：https://github.com/springfox/springfox/issues/2298.

然而，我通过修补几个招摇过市的类成功地解决了这个问题。该补丁背后的想法是使用JavaOptional，而不是Guava和Java反射。补丁类包括：

• springfox.documentation.spring.data.rest.实体服务提供商
• springfox.documentation.spring.data.rest.EntityContext
• springfox.documentation.spring.data.rest.实体DeleteExtrator
• springfox.documentation.spring.data.rest.实体FindAllExtrator
• springfox.documentation.spring.data.rest.实体FindOneExtrator
• springfox.documentation.spring.data.rest.实体保存提取器