public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
.select()
// 请求处理选择器,扫描controller层
.apis(RequestHandlerSelectors.basePackage(“com.lv.code.controller”))
// 上面包内的所有请求
.paths(PathSelectors.any())
.build();
}
//api简介
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title(“l蹦跶v”)
.description(“SwaggerDemo API DOC”)
.version(“1.0”)
.termsOfServiceUrl(“https://www.bd.com”)
.build();
}
}
启动进入：
在controller层方法内指定提交方法：
@RequestMapping(“/login”,method= RequestMethod.POST)
public ResponseResult login(@RequestBody User user){
return userService.findUserByAccount(user);
}
可以尝试连接：
填完数据连接：
访问成功：
3、swagger常用注解
| 注解 | 位置 | 作用 | 参数 |
| @Api | 类 | 标识这个类是swagger的资 源 | 源 tags：说明该类的作用，参数是个数组，可以填多个。 |
| value="该参数没什么意 义，在UI界面上不显示，所以不用配置" | |||
| description = "用户基本信息操作" | |||
| @ApiOperation | 方法 | 表示一个http请求的操作 | value="方法的用途和作 用" |
| notes="方法的注意事项和备注" | |||
| tags：说明该方法的作用， 参数是个数组，可以填多 个。 | |||
| 格式：tags={"作用1","作用2"} | |||
| @ApiParam | 方法， 参数 | 对参数使用说明（如：说明 或是否必填等） | value="用户名" 描述参数的意义 |
| name="name" 参数的变量名 | |||
| required=true 参数是否必选 | |||
| @ApiModel | 类 | 表示对类进行说明，用于参 数用实体类接收，一般用在DTO上 | description="描述实体的作用" |
| @ApiModelProperty | 方 法， 字段 | 表示对model属性的说明 | value="用户名" 描述参数的意义 |
| name="name" 参数的变量名 | |||
| required=true 参数是否必选 | |||
| @ApiIgnore | 类， 方 法， 参数 | 表示这个方法或者类被忽略 | 无 |
| @ApiImplicitParams | 方法 | 包含多@ApiImplicitParam | |
| @ApiImplicitParam | 方法 | 表示单独的请求参数 | name="参数名称" |
| value="参数说明" | |||
| dataType="数据类型" | |||
| paramType="query" 表示 参数放在哪里 |
hea 《一线大厂Java面试题解析+后端开发学习笔记+最新架构讲解视频+实战项目源码讲义》无偿开源 威信搜索公众号【编程进阶路】 der 请求参数的获取：@RequestHeader
query 请求参数的获取：@RequestParam
path（用于restful接口） 请求参数的获取：@PathVariable
body（不常用）
form（不常用）
defaultValue=" 参数的默认值 "
required=“true” 表示参数是否必须传 |
更全面的信息可以参考官方说明文档：
例如：swagger-annotations 1.3.10 API
package com.lv.code.controller;
import com.lv.code.pojo.User;
import com.lv.code.service.IuserService;
import com.lv.code.util.response.ResponseResult;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.annotation.Async;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping(“/user”)
@Api(tags = “用户操作类”)
public class UserController {
@Autowired
private IuserService userService;
@ApiOperation(value = “登录方法”)
@ApiImplicitParam(value=“user”,required = true,name = “用户信息”,paramType = “body”)
@RequestMapping(value=“/login”,method= RequestMethod.POST)
public ResponseResult login(@RequestBody User user){
return userService.findUserByAccount(user);
}
}
实体类：
package com.lv.code.pojo;
import java.io.Serializable;
import java.util.Date;
import com.fasterxml.jackson.annotation.JsonFormat;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;
import org.springframework.format.annotation.DateTimeFormat;
import javax.persistence.*;
@Data
@Table(name = “t_user”)
@AllArgsConstructor
@NoArgsConstructor
@Accessors(chain = true)
@ApiModel(description = “用户实体类”)
public class User implements Serializable {
// 组件自增
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
@ApiModelProperty(name = “id”,value = “用户id”,example = “0”)
private Long id;
@ApiModelProperty(name = “account”,value = “用户账号”,example = “”)
private String account;
@ApiModelProperty(name = “password”,value = “用户密码”,example = “”)
private String password;
