【java】1000问5SpingBoot如何快速集成swagger2

废话不多说，swagger2就是接口的便捷文档查询页面。

 

1、首先pom.xml引入依赖包

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

2、在DemoApplication的同级package中创建配置类 包名删除了，太多了。

package com.example.demo;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
 	@Bean
 	public Docket createRestApi(){
 		return new Docket(DocumentationType.SWAGGER_2)
 			.pathMapping("/")
 			.select()
 			.apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
 			.paths(PathSelectors.any())
 			.build()
 			.apiInfo(new ApiInfoBuilder()
 				.title("SpringBoot整合Swagger")
 				.description("项目接口的详细信息")
 				.version("1.0.0")
 				.contact(new Contact("付华国", "byteyun.net", "fhg1225@126.com"))
 				.build()
 			);
 	}
}

此时如果我们不先进行定义接口直接运行的话，启动项目：

访问：注意你的端口号：http://localhost:8080/swagger-ui.html

3、接下来我们定义接口的配置说明

4、重新启动项目刷新页面：

接口参数说明：

@Api注解可以用来标记当前Controller的功能。

@ApiOperation注解用来标记一个方法的作用。

@ApiImplicitParam注解用来描述一个参数，可以配置参数的中文含义，也可以给参数设置默认值，这样在接口测试的时候可以避免手动输入。

如果有多个参数，则需要使用多个@ApiImplicitParam注解来描述，多个@ApiImplicitParam注解需要放在一个@ApiImplicitParams注解中。

需要注意的是，@ApiImplicitParam注解中虽然可以指定参数是必填的，但是却不能代替@RequestParam(required = true)，前者的必填只是在Swagger2框架内必填，抛弃了Swagger2，这个限制就没用了，所以假如开发者需要指定一个参数必填，@RequestParam(required = true)注解还是不能省略。

如果参数是一个对象（例如上文的更新接口），对于参数的描述也可以放在实体类中。例如下面一段代码：

@ApiModel
public class User {
    @ApiModelProperty(value = "用户id")
    private Integer id;
    @ApiModelProperty(value = "用户名")
    private String username;
    @ApiModelProperty(value = "用户地址")
    private String address;
    //getter/setter
}

接口参数示例说明：

 整体的controller类：

package com.example.demo.controller;

@Api(tags = "用户管理相关接口")
@RestController
@RequestMapping("/hello")
public class HelloController {
    @Autowired
    private UserService userService;
    
    @ApiOperation("获取用户列表")
    @GetMapping("/getUserList")
    public List<UserBase> getUserList(){
        return userService.getUserList();
    }
    
    @ApiOperation("添加用户的接口")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "username", value = "用户名", defaultValue = "李四"),
            @ApiImplicitParam(name = "address", value = "用户地址", defaultValue = "深圳", required = true)
    }
    )
    @PostMapping("/addUser")
    public Map<String,Object> addUser(String username, @RequestParam(required = true) String address) {
        return new HashMap<String, Object>();
    }
    
    @GetMapping("/getUserById")
    @ApiOperation("根据id查询用户的接口")
    @ApiImplicitParam(name = "id", value = "用户id", defaultValue = "99", required = true)
    public UserBase getUserById(@PathVariable String id) {
    	UserBase user = new UserBase();
        user.setId(id);
        return user;
    }
    
    @GetMapping("/index")
    public String index(String id){
        return id;
    }
}

参考文档地址：https://blog.csdn.net/u012702547/article/details/88775298