Spring Boot教程(17)-Spring Boot集成Swagger
Spring Boot教程（1）创建Spring项目
Spring Boot教程(2) – 运行第一个项目
Spring Boot教程(3)-配置文件-多环境配置
Spring Boot教程(4)-日志配置-logback和使用。
Spring Boot教程(5)-web应用开发-模板引擎Thymeleaf
Spring Boot教程(6)-web应用开发-错误处理
Spring Boot教程(7)-文件上传
Spring Boot教程(8)-使用SQL关系型数据库-JdbcTemplate
Spring Boot教程(9)-Spring-data-jpa
Spring Boot教程(10)-使用SQL关系型数据库-h2嵌入式数据库的使用
Spring Boot教程(11)-redis
Spring Boot教程(12)-redis缓存设置，幂等性防重复提交
Spring Boot教程(13)-使用异步消息服务-JMS（ActiveMQ)
Spring Boot教程(14)-使用异步消息服务-AMQP（RabbitMQ）
Spring Boot教程(15)-集成mybatis
Spring Boot教程(16)-集成Druid阿里数据库连接池
Spring Boot教程(17)-Spring Boot集成Swagger
一、Swagger 是什么？
Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。http://swagger.io/
Springfox 的前身是 swagger-springmvc，是一个开源的 API doc 框架，可以将我们的 Controller 的方法以文档的形式展现，基于 Swagger。http://springfox.github.io/springfox/
二、添加依赖
io.springfox
springfox-swagger-ui
2.6.1
io.springfox
springfox-swagger2
2.6.1
三、配置类
package com.wsj.springbootdemo.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
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;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import static springfox.documentation.builders.PathSelectors.regex;
/**
* 项目名称：Swagger2Configuration;
* 类 名 称：Swagger2Configuration;
* 类 描 述：TODO ;
* 创 建 人：Angus;
* 创建时间：2020/5/7 22:23;
*
* @version：1.0
**/
@Configuration
@EnableSwagger2
public class Swagger2Configuration {
/**
*
* @return
*/
@Bean
public Docket accessToken() {
return new Docket(DocumentationType.SWAGGER_2).groupName("api")// 定义组
.select() // 选择那些路径和 api 会生成 document
.apis(RequestHandlerSelectors.basePackage("com.wsj.springbootdemo.controller")) // 拦截的包 路径
.paths(regex("/*/.*"))// 拦截的接口路径
.build() // 创建
.apiInfo(apiInfo()); // 配置说明
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()//
.title("springbootdemo")// 标题
.description("spring boot 全集")// 描述
.termsOfServiceUrl("https://javawsj.blog.csdn.net/")//
.contact(new Contact("wsj", "https://javawsj.blog.csdn.net/",
"[email protected]"))// 联系
// .license("Apache License Version 2.0")// 开源协议
// .licenseUrl("https://github.com/springfox/springfox/blob/master/LICENSE")// 地址
.version("1.0")// 版本
.build();
}
}
四、测试
http://localhost:8081/wsj/swagger-ui.html
五、注解的使用
常用注解：
@ApiIgnore 忽略暴露的 api
@ApiOperation(value = "查找", notes = "根据用户 ID 查找用户") 添加说明 一半用在方法上
@Api ：用在类上，说明该类的作用
其它注解使用：
@ApiImplicitParams ：用在方法上包含一组参数说明
@ApiResponses ：用于表示一组响应
@ApiResponse ：用在@ApiResponses 中，一般用于表达一个错误的响应信息
code：数字，例如 400
message：信息，例如"请求参数没填好"
response：抛出异常的类
@ApiModel ：描述一个 Model 的信息（这种一般用在 post 创建的时候，使用@RequestBody 这样的场
景，请求参数无法使用@ApiImplicitParam 注解进行描述的时候）
@ApiModelProperty ：描述一个 model 的属性
更多请查看
https://github.com/swagger-api/swagger-core/wiki/Annotations
项目地址：
github地址：https://github.com/itwsj/springbootdemo