1 <dependency>
 2     <groupId>io.springfox</groupId>
 3     <artifactId>springfox-swagger2</artifactId>
 4     <version>2.6.1</version>
 5 </dependency>
 6 <dependency>
 7     <groupId>io.springfox</groupId>
 8     <artifactId>springfox-swagger-ui</artifactId>
 9     <version>2.6.1</version>
10 </dependency>

 1 @RestController
 2 @Api(tags = "会员接口")
 3 public class UserController {
 4
 5     @PostMapping("/login")
 6     @ApiOperation(value = "登录")
 7     public LoginRp login(@RequestBody LoginRq rq) {
 8         LoginRp rp = new LoginRp();
 9
10         if (rq.getUserName().isEmpty() || rq.getUserPwd().isEmpty()) {
11             rp.setCode(EmApiCode.登录账号或密码不能为空.getVal());
12             return rp;
13         }
14
15         if (rq.getUserName().equals("shenniu001") && rq.getUserPwd().equals("123")) {
16             rp.setCode(EmApiCode.成功.getVal());
17
18             rp.setToken(UUID.randomUUID().toString());
19         } else {
20             rp.setCode(EmApiCode.失败.getVal());
21         }
22         return rp;
23     }
24
25 }

 1 @ApiModel
 2 public class LoginRq implements Serializable{
 3
 4     private static final long serialVersionUID = -158328750073317876L;
 5
 6     @ApiModelProperty(value = "登录账号")
 7     private String userName;
 8
 9     @ApiModelProperty(value = "登录密码")
10     private String userPwd;
11
12 }
13
14 @ApiModel
15 public class LoginRp extends BaseRp implements Serializable {
16     private static final long serialVersionUID = -1486838360296425228L;
17
18     @ApiModelProperty(value = "授权token")
19     private String token;
20
21     public String getToken() {
22         return token;
23     }
24
25     public void setToken(String token) {
26         this.token = token;
27     }
28 }

View Code

 1 @Configuration
 2 @EnableSwagger2
 3 public class Swagger2 {
 4
 5     @Bean
 6     public Docket createRestApi() {
 7
 8         return new Docket(DocumentationType.SWAGGER_2)
 9                 .select()
10                 //过滤默认错误api
11                 .paths(Predicates.not(PathSelectors.regex("/error.*")))
12                 .build()
13                 .apiInfo(apiInfo());
14     }
15
16     //常用的细节
17     //过滤指定的action
18     //添加授权token列
19     //添加上传文件列
20     private ApiInfo apiInfo() {
21         return new ApiInfoBuilder()
22                 .title("开车接口文档")
23                 .description("该文档只允许我使用")
24                 //版本
25                 .version("0.0.0.1")
26                 .contact("作者：841202396@qq.com")
27                 .build();
28     }
29 }

 1 @Component
 2 @Primary
 3 public class DocumentationConfig implements SwaggerResourcesProvider {
 4     @Override
 5     public List<SwaggerResource> get() {
 6         List resources = new ArrayList<>();
 7         resources.add(swaggerResource("开车接口api", "/v2/api-docs", "0.0.0.1"));
 8         resources.add(swaggerResource("坐车接口api", "/v2/api-docs", "0.0.0.1"));
 9         return resources;
10     }
11
12     private SwaggerResource swaggerResource(String name, String location, String version) {
13         SwaggerResource swaggerResource = new SwaggerResource();
14         swaggerResource.setName(name);
15         swaggerResource.setLocation(location);
16         swaggerResource.setSwaggerVersion(version);
17         return swaggerResource;
18     }
19 }

1 //过滤默认错误api
2 paths(Predicates.not(PathSelectors.regex("/error.*")))

 1 @Bean
 2     public Docket createRestApi() {
 3
 4         List<Parameter> pars = new ArrayList<>();
 5         //添加授权token
 6         ParameterBuilder tokenPar = new ParameterBuilder();
 7         tokenPar.name("token").description("授权token 注：登录不需要填，只有post方式的接口必填").
 8                 modelRef(new ModelRef("string")).
 9                 parameterType("header").required(false).build();
10         pars.add(tokenPar.build());
11
12         return new Docket(DocumentationType.SWAGGER_2)
13                 .select()
14                 .paths(Predicates.not(PathSelectors.regex("/error.*")))
15                 .build()
16                 .globalOperationParameters(pars)
17                 .apiInfo(apiInfo());
18    }

1 @PostMapping(value = "/upload",headers = "content-type=multipart/form-data")
2     @ApiOperation(value = "上传")
3     public BaseRp upload(@ApiParam(value = "上传的文件",required = true) @RequestBody MultipartFile file) {
4         BaseRp rp = new BaseRp();
5
6         rp.setMessage("上传文件名："+file.getOriginalFilename());
7
8         return rp;
9     }