1、添加依赖
Maven依赖示例:
io.springfox
springfox-swagger2
io.springfox
springfox-swagger-ui
2、在 Spring Boot 配置文件中添加配置参数。
swagger:
title: API标题
description: API描述
version: 1.0
terms-of-service-url: http://www.javastack.cn/
base-package: cn.javastack.test.web
contact:
name: Javastack
url: http://www.javastack.cn/
email: admin@javastack.cn
3、添加配置类
@Getter
@Setter
@Configuration
@EnableSwagger2
@ConditionalOnClass(EnableSwagger2.class)
@ConfigurationProperties(prefix = “swagger”)
public class SwaggerConfig {
/**
* API接口包路径
/
private String basePackage;
/*
* API页面标题
/
private String title;
/*
* API描述
/
private String description;
/*
* 服务条款地址
/
private String termsOfServiceUrl;
/*
* 版本号
/
private String version;
/*
* 联系人
*/
private Contact contact;
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage(basePackage))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title(title)
.description(description)
.termsOfServiceUrl(termsOfServiceUrl)
.version(version)
.contact(contact)
.build();
}
}
如何使用
Swagger 默认会根据配置的包,扫描所有接口并生成对应的 API 描述和参数信息,但这样不是很直观,需要对每个接口和参数进行自定义描述。
常用的 Swagger 注解如下。
注解名称 使用说明
@Api 描述一个 API 类
@ApiImplicitParam 描述一个请求参数
@ApiImplicitParams 描述一组请求参数
@ApiModel 描述一个返回的对象
@ApiModelProperty 描述一个返回的对象参数
@ApiOperation 描述一个 API 方法
@ApiParam 描述一个方法的参数
@ApiResponse 描述一个请求响应
@ApiResponses 描述一组请求响应
使用示例如:
@Api(description = “登录模块”)
@RestController
public class LoginController {
@ApiOperation(value = “登录”, httpMethod = “POST”)
@ApiImplicitParams({
@ApiImplicitParam(name = “username”, value = “用户名”, dataType = “string”, paramType = “query”),
@ApiImplicitParam(name = “password”, value = “密码”, dataType = “string”, paramType = “query”)})
@PostMapping(value = “/login”)
public Object login(@RequestParam(“username”) String username, @RequestParam(“password”) String password) {
// …
}
}
Spring Boot 集成 Swagger
最新推荐文章于 2024-08-20 17:25:50 发布