包引入
不用swagger2原生态的,使用第三方包
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>2.0.7</version>
</dependency>
配置
import com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver;
import lombok.AllArgsConstructor;
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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;
/**
* 文档配置
*
*
*/
@Configuration(proxyBeanMethods = false)
//要开启swaggerWebMvc
@EnableSwagger2WebMvc
@AllArgsConstructor
public class DocumentConfig {
private final OpenApiExtensionResolver openApiExtensionResolver;
@Bean
public Docket appDocket() {
return new Docket(DocumentationType.SWAGGER_2)
.pathMapping("/")
.apiInfo(new ApiInfoBuilder()
.title("API接口")
.build())
.groupName("API")
.select()
//这里指定Controller扫描包路径
.apis(RequestHandlerSelectors.basePackage("com.wolf.api.controller"))
.paths(PathSelectors.any())
.build()
//添加markdown文档支持
.extensions(openApiExtensionResolver.buildExtensions("other"));
}
}
添加静态资源过滤
@Configuration
public class SpringMVCConfig extends WebMvcConfigurationSupport {
/**
* 加入资源静态资源过滤
* <mvc:resources mapping="/js/**" location="/js/"/>
* <mvc:resources mapping="/css/**" location="/css/"/>
* <mvc:resources mapping="/html/**" location="/html/"/>
* 添加资源过滤,否则文档无法访问
* @param registry
*/
@Override
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
registry
//要映射的位置
.addResourceHandler("/**")
//资源路径位置
.addResourceLocations("/");
}
}
另外如果你用了权限框架例如springSecurity的时候,需要把资源进行放行,否则不然访问不到
application.yml增加放行资源配置
###权限配置###
auth:
cache-prefix: ${spring.application.name}
ignore:
urls:
- /actuator/**
- /favicon.ico
- /swagger-resources/**
- /v2/api-docs/**
- /v2/api-docs-ext/**
- /doc.html
- /webjars/**
- /**
配置文件
@Data
@Component
@ConfigurationProperties(prefix = "auth")
public class AuthProperties {
/**
* 缓存前缀
*/
private String cachePrefix;
/**
* token相关设置
*/
@NestedConfigurationProperty
private Token token = new Token();
/**
* 忽略认证相关设置
*/
@NestedConfigurationProperty
private Ignore ignore = new Ignore();
}
//忽略认证
urlRegistry
.antMatchers(ArrayUtil.toArray(authProperties.getIgnore().getUrls(), String.class)).permitAll()
.anyRequest().authenticated();
配置文件启用swagger2(application.yml)
###api文档配置###
knife4j:
enable: true
documents:
- group: other
locations: classpath:markdown/*
name: 其他文档
项目启动后效果
swagger相关注解使用说明
创建接口
接下来就是创建接口了,Swagger2相关的注解其实并不多,而且很容易懂,下面我来分别向小伙伴们举例说明:
@RestController
@Api(tags = "用户管理相关接口")
@RequestMapping("/user")
public class UserController {
@PostMapping("/")
@ApiOperation("添加用户的接口")
@ApiImplicitParams({
@ApiImplicitParam(name = "username", value = "用户名", defaultValue = "李四"),
@ApiImplicitParam(name = "address", value = "用户地址", defaultValue = "深圳", required = true)
}
)
public RespBean addUser(String username, @RequestParam(required = true) String address) {
return new RespBean();
}
@GetMapping("/")
@ApiOperation("根据id查询用户的接口")
@ApiImplicitParam(name = "id", value = "用户id", defaultValue = "99", required = true)
public User getUserById(@PathVariable Integer id) {
User user = new User();
user.setId(id);
return user;
}
@PutMapping("/{id}")
@ApiOperation("根据id更新用户的接口")
public User updateUserById(@RequestBody User user) {
return user;
}
}
这里边涉及到多个API,我来向小伙伴们分别说明:
- @Api注解可以用来标记当前Controller的功能。
- @ApiOperation注解用来标记一个方法的作用。
- @ApiImplicitParam注解用来描述一个参数,可以配置参数的中文含义,也可以给参数设置默认值,这样在接口测试的时候可以避免手动输入。
如果多个参数的时候
@ApiImplicitParams({
@ApiImplicitParam(value = "版本号 如果不传,则获取最新版本号", name = "version"),
@ApiImplicitParam(value = "项目code", name = "code", example = "android")
})
- 如果有多个参数,则需要使用多个@ApiImplicitParam注解来描述,多个@ApiImplicitParam注解需要放在一个@ApiImplicitParams注解中。
- 需要注意的是,@ApiImplicitParam注解中虽然可以指定参数是必填的,但是却不能代替@RequestParam(required = true)它仅仅告诉开发人员,这项参数是必填项实际不起作用,前者的必填只是在Swagger2框架内必填,抛弃了Swagger2,这个限制就没用了,所以假如开发者需要指定一个参数必填,@RequestParam(required = true)注解还是不能省略。
- 如果参数是一个对象(例如上文的更新接口),对于参数的描述也可以放在实体类中。例如下面一段代码:
@ApiModel
public class User {
@ApiModelProperty(value = "用户id")
private Integer id;
@ApiModelProperty(value = "用户名")
private String username;
@ApiModelProperty(value = "用户地址")
private String address;
//getter/setter
}
4、新增
@ApiSupport(order = 3)
用于控制生成的接口在接口文档的位置。
@ApiOperationSupport(order = 1)
用于控制生成的接口在模块中的位置
推荐学习:
http://springboot.javaboy.org/2019/0416/springboot-swagger 江南一点雨