【SpringFox / Swagger文档生成工具】使用过程中的几个问题积累

最新推荐文章于 2024-07-26 14:54:01 发布

F_GSong

最新推荐文章于 2024-07-26 14:54:01 发布

阅读量1.3w

点赞数

分类专栏： Java Web 文章标签： Springfox Swagger 文档生成工具 api接收对象文档空白

本文链接：https://blog.csdn.net/Hero06206/article/details/52668440

版权

本文介绍了SpringFox Swagger在使用过程中遇到的三个问题：1. Controller API使用对象接收URL参数的注解；2. Swagger文档显示为空，可能由于与自定义HttpMessageConverter不兼容；3. 访问`/swagger-ui.html`时找不到处理程序。针对这些问题，提供了详细的解决方案，包括在配置类中忽略特定参数类型，使用`@ApiImplicitParams`和`@ApiImplicitParam`注解，以及调整Spring Boot的资源处理器配置。

摘要由CSDN通过智能技术生成

转载本文请标明出处，谢谢！

SpringFox是最新版的Swagger文档生成工具，SpringFox官方文档参见：SpringFox官方参考文档

SpringFox与Spring Boot的集成

添加配置类

package focuson.config;

import com.dianrong.labelaggregator.protocol.request.DisplayLabelsRequest;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @Date 16-3-20 上午11:55
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder().title("用户查询系统API").description("用户查询系统API Document").build())
                .ignoredParameterTypes(UserRequest.class) //忽略“/list”接口参数