SwaggerConfig 使用小技巧

最新推荐文章于 2024-05-17 14:24:09 发布

wuzhenwei0419

最新推荐文章于 2024-05-17 14:24:09 发布

阅读量7.5k

点赞数

CC 4.0 BY-SA版权

文章标签： SwaggerConfig Swagger

本文链接：https://blog.youkuaiyun.com/wuzhenwei0419/article/details/84110884

本文介绍了一个使用Swagger进行API文档自动生成的配置示例，详细展示了如何通过代码配置全局请求参数，如登录令牌，以及如何指定API信息和路径选择。

@Configuration
@EnableSwagger2
@EnableAutoConfiguration
public class SwaggerConfig
{

    @Bean
    public Docket createRestApi() {
        ParameterBuilder tokenPar = new ParameterBuilder();
        //用来统一一些公用参数，这里设置前端和后台登录的输入参数
        List<Parameter> pars = new ArrayList<Parameter>();
        tokenPar.name("sessionId")
                .description("登录令牌")
                .modelRef(new ModelRef("string"))
                .parameterType("header")  //参数类型为header中的参数
                .required(false)
                .build();

        ParameterBuilder tokenPar1 = new ParameterBuilder();
        tokenPar1.name("backSessionId")
                .description("后台登录令牌")
                .modelRef(new ModelRef("string"))
                .parameterType("header")
                .required(false)
                .build();

        pars.add(tokenPar.build());
        pars.add(tokenPar1.build());

        return new Docket(DocumentationType.SWAGGER_2)
                .globalOperationParameters(pars)//定义全局的请求参数
                //.globalResponseMessage( customerResponseMessage())//用来自定义全局返回错误码
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.lovego.cloud.user"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("用户中心API")
                .description("用户中心相关API接口")
                .termsOfServiceUrl("http://localhost:9002")
                .contact("Cory")
                .version("1.0")
                .build();
    }
}

如果项目要上生产的时候在配置文件中添加swagger.enable: false即可