swagger

原创已于 2022-03-31 15:30:14 修改 · 87 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java #开发语言

于 2022-03-18 08:43:00 首次发布

本文档介绍了如何在Spring Boot项目中集成Springfox，通过@EnableSwagger2注解启用Swagger2，并配置Docket来定制API信息。同时，展示了如何添加自定义头部参数，并配置资源处理器以展示Swagger UI。此外，还提供了@Api和@ApiOperation注解的使用示例，帮助开发者创建详细的RESTful API文档。

1、依赖

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>${springfox-swagger2.version}</version>
</dependency>

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>${springfox-swagger-ui.version}</version>
</dependency>

2、加上@EnableSwagger2注解

@Configuration
@ConditionalOnProperty(name = "swagger.enable", havingValue = "true")
@EnableSwagger2     //控制swagger是否可用
public class Swagger2 {

    @Bean
    public Docket createRestApi() {
        //添加head参数start
        ParameterBuilder tokenPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<>();
        tokenPar.name("Authorization").description("用户授权信息").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
        pars.add(tokenPar.build());
        //添加head参数end

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.dimpt"))
                .paths(PathSelectors.any())
                .build()
                .globalOperationParameters(pars);
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("5G Robot Server APIS")
                .version("1.0")
                .build();
    }

}

配置拦截器

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