20190909 SpringBoot集成Swagger
2024-10-19 17:45:06
SpringBoot集成Swagger
1. 引入依赖
// SpringBoot
compile('org.springframework.boot:spring-boot-starter-web')
compile('org.springframework.boot:spring-boot-starter-actuator')
// springfox-swagger
compile('io.springfox:springfox-swagger2:2.9.2')
compile('io.springfox:springfox-swagger-ui:2.9.2')
2. 配置类
2.1. 配置WebMvc
@Configuration
@EnableWebMvc
public class WebMvcConfig {
}
2.2. 配置Swagger
@Configuration
@EnableSwagger2
public class SwaggerConfig implements WebMvcConfigurer {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("test.hwj.swagger"))
.paths(PathSelectors.any()).build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder().title("测算项目").description("测算项目API接口文档").version("1.0").build();
}
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}
}
3. 常用注解
3.1. @Api
用于声明类,属性tags提供说明
3.2. @ApiOperation
用于声明方法,属性value提供说明
3.3. @ApiParam
用于声明参数,属性value提供说明,属性required显示是否为必需项,默认为false
3.3. @ApiImplicitParams和@ApiImplicitParam
用于声明方法,说明方法的参数,与@ApiParam
不同之处在于:
1. 将对参数的说明放在方法声明上,集中在一起;
2. @ApiParam
只适用于和JAX-RS 1.x/2.x联合使用;
3.4. @ApiModel()
用于声明实体类,属性value提供说明
@ApiModelProperty
用于声明实体类字段,属性value提供说明
最新文章
- PPT开发 * .pps 文件类型
- SQL Server编程(03)自定义存储过程
- poj 1060
- 苹果app审核的规则总结
- Dungeon Master 分类: 搜索 POJ 2015-08-09 14:25 4人阅读 评论(0) 收藏
- 利用System.Net.Mail和多线程实现邮件发送
- ios-王云鹤 把UIdatePicker 嵌入到 UIActionSheet中
- js时间戳与日期格式的相互转换
- iOS 使用AVAudioPlayer开发录音功能
- SQL 注入~MySQL专题
- MariaDB基本操作--(创建用户)(转)
- 20171017数据处理sql
- js switch 字符串
- DAY 30 网络编程基础
- 21.PHP实现Word/Excel/PPT转换为PDF
- openStack instance error 恢复
- BZOJ1827[USACO 2010 Mar Gold 1.Great Cow Gathering]——树形DP
- 关于uframe源码的一些解读
- EntityFramework 系列:实体类配置-根据依赖配置关系和关联
- bash: /usr/bin/npm: No such file or directory
热门文章
- Ubuntu 16.04安装N卡驱动、cuda、cudnn和tensorflow GPU版
- docker配置Nginx
- 【转】linux 查看哪些进程用了swap
- Beta冲刺-(2/3)
- 03python面向对象编程1
- Linux日常之以当前时间命名文件
- Educational Codeforces Round 55 (Rated for Div. 2) C. Multi-Subject Competition (实现,贪心,排序)
- 磁盘,fdisk分区,MBR,dd命令
- 【JavaScript】 命名空间污染解决
- 使用IDEA自动生成Java实体类