springboot 整合swagger2

1、导入依赖
		<!-- swagger2的依赖-->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger-ui</artifactId>
			<version>2.9.2</version>
		</dependency>
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>2.9.2</version>
		</dependency>
2、编写swagger2的配置类
@Configuration
public class SwaggerConfig {

    // 设置默认TOKEN,方便测试
    private static final String TOKEN = "";
    @Bean
    public Docket api() {
        //添加token,并设置默认的token
        ParameterBuilder tokenPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<Parameter>();
        tokenPar.name("Authorization")
        	.description("令牌")
        	.defaultValue(TOKEN)
        	.modelRef(new ModelRef("string"))
        	.parameterType("header")
        	.required(false)
        	.build();
        pars.add(tokenPar.build());
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build()
                //设置全局参数Authorization
                .globalOperationParameters(pars)
                .apiInfo(apiInfo());
//                .useDefaultResponseMessages(false)
//                .globalResponseMessage(RequestMethod.GET, newArrayList(new ResponseMessageBuilder().code(500).message("500 message").responseModel(new ModelRef("Error")).build(), new ResponseMessageBuilder().code(403).message("Forbidden!!!!!").build()));
        return docket;
    }
    
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("swagger2 ----")
                .version("1.0")
                .description("API 描述")
                //条款地址
//                .termsOfServiceUrl("http://despairyoke.github.io/")
//                .contact("zwd")
                .build();
    }
}
3、启动类上加上@EnableSwagger2注解
@SpringBootApplication
@EnableSwagger2
public class DemoApplication {
	public static void main(String[] args) {
		SpringApplication.run(DemoApplication.class, args);
	}
}
4、在接口中使用swagger注解
@RestController
@RequestMapping("/user")
@Api(value = "用户中心接口", description = "用户中心api")
public class UserController {

    @Autowired
    private UserService userService;
    
    @GetMapping("/getUser/{phone}")
    @ApiOperation(value = "通过手机号查询用户",httpMethod = "GET",produces = MediaType.APPLICATION_JSON_VALUE,response = User.class)
    public User getUser(@ApiParam(name = "手机号", required = true) @PathVariable("phone") String phone){
        return userService.findByphone(phone);
    }
}

在这里插入图片描述

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值