Spring Boot 入门整合目录

Spring Boot使用swagger2

导入swagger2 的依赖

<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>

配置swagger2

@Configuration
@EnableSwagger2
public class Swagger2Config {

@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors
.basePackage("com.lemon.hellospringboot.controller"))
//扫描所有有注解的api，用这种方式更灵活 没有ApiOperation注解就扫描不到
// .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
.paths(PathSelectors.any())
.build();
}

private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("springboot 使用 swagger2 ")//标题
.description("前后端分离 api 接口文档")//描述
.termsOfServiceUrl("https://me.csdn.net/weixin_43479025")//网站
.version("1.0")//版本号
.build();
}

}

启动类加上@EnableSwagger2 注解才能生效
访问http://127.0.0.1:8080/swagger-ui.html

编写controller

@Api
@RestController
public class WebController {

@PostMapping("login")
@ApiOperation(value = "登录")
public User login(User user){
return user;
}

}

编写 entity

public class User {

private Integer id;
@ApiModelProperty(value = "用户名")
private String username;
@ApiModelProperty(value = "用户密码")
private String password;

public Integer getId() {
return id;
}

public void setId(Integer id) {
this.id = id;
}

public String getUsername() {
return username;
}

public void setUsername(String username) {
this.username = username;
}

public String getPassword() {
return password;
}

public void setPassword(String password) {
this.password = password;
}
}

基本注解介绍：
@Api：修饰整个类，描述Controller的作用
@ApiOperation：描述一个类的一个方法，或者说一个接口
@ApiImplicitParams：多个请求参数
@ApiImplicitParam：一个请求参数
@ApiModel：用对象来接收参数
@ApiModelProperty：用对象接收参数时，描述对象的一个字段
@ApiIgnore：使用该注解忽略这个API

• 点赞 1
• 收藏
• 分享
• 文章举报