java - Swagger Springfox配置问题

Question

我有一个应用程序使用 Spring MVC 来处理 REST 调用， Controller 是 REST Controller 并用 @RestController 注释， Controller 及其方法用 @RequestMapping 注释.

我正在尝试添加 Swagger 以生成现有 REST 服务的文档。我正在尝试将它添加为一个测试以查看它的外观。我添加了 springfox和 ui库，将 swagger 配置类和 bean 定义添加到 spring context xml文件。我可以打 swagger-ui.html链接，但它根本不生成任何文档。由于文档稀少，我不知道自己做错了什么或配置有误，而且谷歌搜索这个问题也没有产生任何有用的信息。

任何人都可以就我可能做错的地方提供一些建议，或者提供一些比我目前找到的更好的文档吗？

我在我的 pom 文件中添加了 springfox-swagger2 和相关的 ui 条目，添加了这个:到我的 spring 文件，以及这些类的两个新 bean 定义:

 @Configuration
@EnableSwagger2
public class ApplicationSwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }

}

@EnableWebMvc
public class SwaggerConfiguration extends WebMvcConfigurerAdapter {

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");

        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

}

我已经尝试在我的 spring xml 中的第二个类中定义 bean，但这也不起作用。我很难过。我已经按照文档中的说明做了，但没有用。有什么想法吗？

Answer 1

springfox 文档可用here .从您的帖子看来，您可能需要执行以下操作

• 为与 springfox 捆绑在一起的 swagger ui 添加依赖项。你应该this dependency springfox-swagger-ui或者 springfox-swagger-ui-rfc6570对你的依赖。
• Configure your swagger-ui resources这样它就可以由您的 spring 应用程序加载，如下所示

    @Override
    public void addViewControllers(ViewControllerRegistry registry) {

            registry.addRedirectViewController("/documentation/v2/api-docs", "/v2/api-docs?group=restful-api");
            registry.addRedirectViewController("/documentation/swagger-resources/configuration/ui","/swagger-resources/configuration/ui");
            registry.addRedirectViewController("/documentation/swagger-resources/configuration/security","/swagger-resources/configuration/security");
            registry.addRedirectViewController("/documentation/swagger-resources", "/swagger-resources");
    }

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
             registry
                   .addResourceHandler("/documentation/swagger-ui.html**")
                   .addResourceLocations("classpath:/META-INF/resources/swagger-ui.html");
            registry
                   .addResourceHandler("/documentation/webjars/**")
                   .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

注意:如果您有 spring boot 应用程序，则不需要这样做。

• 确保您使用的是最新的库版本(在撰写本文时为 2.6.0)
• 验证您是否可以在 http(s)://your-host/context-path/v2/api-docs
看到 swagger 服务描述