1.引入依赖
swagger3所需要的依赖只有一个,比较简单方便
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
2.创建config文件
创建swagger3Config文件
package com.zsht.nettyService.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
/**
* Swagger3配置文件
*
* @author w
* @date 2023/4/20 13:14
*/
@Configuration
public class Swagger3Config {
Boolean swaggerEnabled = true;
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.OAS_30)
.apiInfo(apiInfo())
// 是否开启
.enable(swaggerEnabled)
.select()
// 指定接口的位置
.apis(RequestHandlerSelectors.basePackage("com.zsht.nettyService.controller"))
.paths(PathSelectors.any())
.build();
}
/**
* 配置网站的基本信息
*
* @return
*/
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
// 网站标题
.title("Netty服务接口文档")
// 联系人信息
.contact(new Contact("w", "http://localhost:8085/swagger-ui/index.html#/", "xxx@qq.com"))
// 版本号
.version("1.0")
// 描述
.description("集成Netty服务")
.build();
}
}
3.启动类添加注解
在启动类上添加swagger注解@EnableOpenApi,开启swagger服务
/**
* SpringBoot启动类
*
* @author Administrator
*/
@EnableOpenApi
@SpringBootApplication
public class NettyServiceApplication {
private static final Log log = Log.get();
public static void main(String[] args) {
SpringApplication.run(NettyServiceApplication.class, args);
log.info(">>> " + NettyServiceApplication.class.getSimpleName() + " IS SUCCESS! <<<");
}
}
4.访问swagger
启动程序后,在浏览器输入 http://localhost:8085/swagger-ui/index.html# 进行访问
5.添加注解
我们也可以在接口上添加注释说明,方便我们在接口文档中解释说明接口的信息,例如接口的作用、参数说明等,方便调用者使用
/**
* Netty服务控制器
*
* @author w
* @date 2023/4/19 13:19
*/
@Api(tags = "Netty接口")
@Controller
public class NettyController {
@Autowired
NettyService nettyService;
/**
* 修改设备IP/域名和端口
*
* @author w
* @date 2023-04-19 13:25:11
*/
@ApiOperation("修改设备IP/域名和端口")
@ResponseBody
@PostMapping("/update/Address")
public ResponseData UpdateIpOrAddress(@RequestBody UpdateIpOrAddressRequest request) {
nettyService.UpdateIpOrAddress(request);
return new SuccessResponseData();
}
}
/**
* 修改设备IP/域名和端口请求参数
*
* @author w
* @date 2023/4/19 13:27
*/
@ApiModel(value = "修改设备IP、域名和端口请求参数")
@Data
public class UpdateIpOrAddressRequest {
/**
* 设备编号
*/
@ApiModelProperty(value = "设备编号", name = "sn", notes = "设备编号")
@NotBlank(message = "设备编号不能为空,请检查sn参数")
private String sn;
/**
* IP/域名
*/
@ApiModelProperty(value = "IP/域名", name = "address", notes = "IP地址或者域名")
@NotBlank(message = "IP/域名不能为空,请检查address参数")
private String address;
/**
* 端口号
*/
@ApiModelProperty(value = "端口号", name = "port", notes = "设备端口号")
@NotNull(message = "端口号不能为空,请检查port参数")
private Integer port;
}
6.常用注解
注解 | 说明 |
---|---|
@Api | 用在请求的类上,表示对类的说明 |
tags=“说明该类的作用,可以在UI界面上看到的注解” | |
value=“该参数没什么意义,在UI界面上也看到,所以不需要配置” | |
@ApiOperation | 用在请求的方法上,说明方法的用途、作用 |
value=“说明方法的用途、作用” | |
notes=“方法的备注说明” | |
@ApiImplicitParams | 用在请求的方法上,表示一组参数说明 |
@ApiImplicitParam | 用在@ApiImplicitParams注解中,指定一个请求参数的各个方面 |
name=“参数名” | |
value=“参数的汉字说明、解释” | |
required=“参数是否必须传” | |
paramType=“参数放在哪个地方” | |
· header --> 请求参数的获取:@RequestHeader | |
· query --> 请求参数的获取:@RequestParam | |
· path(用于restful接口)–> 请求参数的获取:@PathVariable | |
· div(不常用) | |
· form(不常用) | |
dataType=“参数类型,默认String,其它值dataType=“Integer”” | |
defaultValue=“参数的默认值” | |
@ApiResponse | 用在请求的方法上表示一组响应,一般用于表达一个错误的响应信息 |
code=“数字,例如400” | |
message=“信息,例如 请求参数没填好” | |
response=“抛出异常的类” | |
@ApiModel | 用于响应类上,表示一个返回响应数据的信息(这种一般用在post创建的时候,使用@RequestBody这样的场景,请求参数无法使用@ApiImplicitParam注解进行描述的时候) |
@ApiModelProperty | 用在属性上,描述响应类的属性 |
7.问题
(1)No parameters
原因
@ApiModel(“xxx/xxx列表查询条件”)
在API注释中出现斜杆 /,Swagger 无法识别斜杆。
解决方案
去掉斜杆改为 @ApiModel(“xxx、xxx列表查询条件”)