springboot+swagger

依赖:

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.7.0</version>
</dependency>

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.7.0</version>
</dependency>

配置:

@EnableSwagger2
@Configuration
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        Predicate<RequestHandler> predicate = new Predicate<RequestHandler>() {
            @Override
            public boolean apply(RequestHandler input) {
                Class<?> declaringClass = input.declaringClass();
                if (declaringClass == BasicErrorController.class) {
                    return false;
                }

                if (declaringClass.isAnnotationPresent(RestController.class)) {
                    return true;
                }

                if (input.isAnnotatedWith(ResponseBody.class)) {
                    return true;
                }
                return false;
            }
        };
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .useDefaultResponseMessages(false)
                .select()
                .apis(predicate)
                .build()
                .globalOperationParameters(setHeaderToken())
                .globalOperationParameters(setVersion())
                ;
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("测试服务")
                .description("测试服务API")
                // 版本
                .version("v1")
                .build();
    }


    /**
     * 设置传送参数-传token(如果设置在header传别的参数,只需加下面方法,并修改:parameterType,最后在上面Docket后面追加即可)
     *
     * @return
     */
    private List<Parameter> setHeaderToken() {
        ParameterBuilder tokenPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<>();
        tokenPar.name("authorization").description("token").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
        pars.add(tokenPar.build());
        return pars;
    }

    /**
     * 设置传送参数-传api version
     *
     * @return
     */
    private List<Parameter> setVersion() {
        ParameterBuilder apiVersion = new ParameterBuilder();
        List<Parameter> parameters = new ArrayList<>();
        apiVersion.name("version")
                .description("接口版本")
                .modelRef(new ModelRef("string"))
                .parameterType("path")
                .required(true)
                .build();
        parameters.add(apiVersion.build());
        return parameters;
    }
}
  • 3
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值