基于SpringBoot的Swagger2快速入门
时间:2019-11-18
本文章向大家介绍基于SpringBoot的Swagger2快速入门,主要包括基于SpringBoot的Swagger2快速入门使用实例、应用技巧、基本知识点总结和需要注意事项,具有一定的参考价值,需要的朋友可以参考一下。
1. Springboot 集成 Swagger2
1.1 导入Swagger2 依赖
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency>
1.2 编写 Swagger 配置:如下简单添加注解即可访问SwaggerUi
@Configuration @EnableSwagger2 public class SwaggerConfig { }
1.3 访问
2. 配置Swagger2
@Configuration @EnableSwagger2 public class SwaggerConfig { /** * 配置Swagger的Docket实例 * @return */ @Bean public Docket docket(){ return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .enable(false) //关闭swagger .groupName("xxx") //分组,多个分组需要多个Docket实例 .select() //接口过滤,扫描包名下的接口 .apis(RequestHandlerSelectors.basePackage("cn.lcx.demo.controller")) .build(); } /** * 配置Swagger信息 * @return */ private ApiInfo apiInfo(){ Contact contact = new Contact("xxx","http://localhost:8080","xxxx@qq.com"); return new ApiInfo( "xxx团队xxx项目api开发文档", "xxx团队xxx项目api开发文档", "1.0", "urn:tos", contact, "Apache 2.0", "http://www.apache.org/licenses/LICENSE-2.0", new ArrayList()); } }
访问http://localhost:8080/swagger-ui.html
3. 编写Api文档注释
3.1 实体类
@ApiModel("用户实体类") //注解在类上的api文档 public class User { @ApiModelProperty("用户名") //注解在属性上的api文档 private String username; @ApiModelProperty("密码") private String password; public void setUsername(String username) { this.username = username; } public void setPassword(String password) { this.password = password; } public String getUsername() { return username; } public String getPassword() { return password; } }
查看ui下面的model
3.2 接口类
@RestController public class HelloController { @ApiOperation("获取用户接口") //注解在方法名上的api文档 @PostMapping("/user") //注解在变量上的api文档 public User getUser(@ApiParam("用户名") String username, @ApiParam("密码") String password){ return new User(); } }
查看ui的接口信息
4. Swagger2 还提供接口在线测试,功能类似postman
原文地址:https://www.cnblogs.com/lcsin/p/11883022.html
- java教程
- Java快速入门
- Java 开发环境配置
- Java基本语法
- Java 对象和类
- Java 基本数据类型
- Java 变量类型
- Java 修饰符
- Java 运算符
- Java 循环结构
- Java 分支结构
- Java Number类
- Java Character类
- Java String类
- Java StringBuffer和StringBuilder类
- Java 数组
- Java 日期时间
- Java 正则表达式
- Java 方法
- Java 流(Stream)、文件(File)和IO
- Java 异常处理
- Java 继承
- Java 重写(Override)与重载(Overload)
- Java 多态
- Java 抽象类
- Java 封装
- Java 接口
- Java 包(package)
- Java 数据结构
- Java 集合框架
- Java 泛型
- Java 序列化
- Java 网络编程
- Java 发送邮件
- Java 多线程编程
- Java Applet基础
- Java 文档注释