目录
Swagger 介绍及使用
Swagger 介绍及使用
Swagger 是一个规范且完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。
Swagger 的目标是对 REST API 定义一个标准且和语言无关的接口,可以让人和计算机拥有无须访问源码、文档或网络流量监测就可以发现和理解服务的能力。当通过 Swagger 进行正确定义,用户可以理解远程服务并使用最少实现逻辑与远程服务进行交互。与为底层编程所实现的接口类似,Swagger 消除了调用服务时可能会有的猜测。
集成 Swagger 我们使用封装好了的 Starter 包,代码如下所示:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
添加配置:
springfox:
documentation:
swagger-ui:
enabled: true
说明:在生产环境中要设置 swagger-ui 的 enabled 值为 false,用来关闭文档的显示。
Swagger 是通过注解的方式来生成对应的 API,在接口上我们需要加上各种注解来描述这个接口,使用方法代码如下所示:
@Configuration
@EnableOpenApi
public class Swagger3Config {
/**
* 创建 API 1.x
*/
@Bean
public Docket createRestApi1() {
String groupName = "1.x";
return new Docket(DocumentationType.OAS_30)
// 添加摘要信息
.apiInfo(new ApiInfoBuilder()
.title("Blog 用户接口文档")
.description("更多请咨询服务开发者 stary。")
.contact(new Contact("stary", "http://www.stary1993.com.cn", "stary1993@qq.com"))
.version("1.0")
.termsOfServiceUrl("http://www.stary1993.com.cn")
.description("Blog RESTful APIs")
.build()
)
.groupName(groupName)
.select()
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
.paths(PathSelectors.any())
.build();
}
}
Swagger 注解的使用说明:
@Api:用在请求的类上,表示对类的说明
tags="说明该类的作用,可以在UI界面上看到的注解"
value="该参数没什么意义,在UI界面上也看到,所以不需要配置"
@ApiOperation:用在请求的方法上,说明方法的用途、作用
value="说明方法的用途、作用"
notes="方法的备注说明"
@ApiImplicitParams:用在请求的方法上,表示一组参数说明
@ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面
name:参数名
value:参数的汉字说明、解释
required:参数是否必须传
paramType:参数放在哪个地方
· header --> 请求参数的获取:@RequestHeader
· query --> 请求参数的获取:@RequestParam
· path(用于restful接口)--> 请求参数的获取:@PathVariable
· body(不常用)
· form(不常用)
dataType:参数类型,默认String,其它值dataType="Integer"
defaultValue:参数的默认值
@ApiResponses:用在请求的方法上,表示一组响应
@ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息
code:数字,例如400
message:信息,例如"请求参数没填好"
response:抛出异常的类
@ApiModel:用于响应类上,表示一个返回响应数据的信息
(这种一般用在post创建的时候,使用@RequestBody这样的场景,
请求参数无法使用@ApiImplicitParam注解进行描述的时候)
@ApiModelProperty:用在属性上,描述响应类的属性
Controller 层的配置:
@RestController
@RequestMapping("/user")
@Api(tags = "用户信息管理")
public class UserController {
private static final Logger logger = LoggerFactory.getLogger(UserController.class);
@ApiOperation(value = "查询用户信息", notes = "根据用户ID查询用户信息")
@ApiImplicitParams(value = {@ApiImplicitParam(name = "id", value = "用户ID")})
@GetMapping("/{id}")
public ResponseEntity findById(@PathVariable Integer id) {
Map<String, Object> user = new HashMap<>(16);
user.put("id", id);
user.put("name", "张三");
logger.info("我是 blog-user-service /user/{}", id);
return new ResponseEntity(user, HttpStatus.OK);
}
}
启动服务,访问 http://localhost:8081/swagger-ui/ 或 http://localhost:8081/swagger-ui/index.html,可以看到 Swagger 界面效果:
当我们的服务中有认证的逻辑,程序中会把认证的 Token 设置到请求头中,在用 Swagger 测试接口的时候也需要带上 Token 才能完成接口的测试。
修改 Swagger3Config
配置类代码:
/**
* 创建 API 1.x
*/
@Bean
public Docket createRestApi1() {
String groupName = "1.x";
return new Docket(DocumentationType.OAS_30)
...
.build()
// 整合 oauth2
.securitySchemes(Collections.singletonList(securitySchemes()))
.securityContexts(Collections.singletonList(securityContexts()));
}
private SecurityScheme securitySchemes() {
return new ApiKey("Authorization", "Authorization", "header");
}
/**
* swagger 认证的安全上下文
*/
private SecurityContext securityContexts() {
return SecurityContext.builder()
.securityReferences(defaultAuth())
.operationSelector(operationContext ->
operationContext.requestMappingPattern().startsWith("/user")
)
.build();
}
private List<SecurityReference> defaultAuth() {
AuthorizationScope authorizationScope = new AuthorizationScope("web", "access_token");
AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
authorizationScopes[0] = authorizationScope;
return Collections.singletonList(new SecurityReference("Authorization", authorizationScopes));
}
重启服务后刷新页面,可以看到多了个 Authorize 按钮,如图所示:
点击该按钮,如图所示:
文本框里要输入从服务器获取的 Token。格式为:Bearer + 空格 + token。 Bearer 可以看作是一个默认的规则。
输入完成后,点击 Authorize 按钮,完成认证,接下来,blog-user-service 中的各种接口就可以直接调用测试。了。
上面这种方式比较通用,不仅仅适用于 OAuth2,也适用于其他一些自定义的 token 登录方式。