SpringBoot | 第十章：Swagger2的集成和使用-白红宇

SpringBoot | 第十章：Swagger2的集成和使用

阅读量：4884 次

发布时间：2019-06-11

本文共 5612 字，大约阅读时间需要 18 分钟。

前言

前一章节介绍了mybatisPlus的集成和简单使用，本章节开始接着上一章节的用户表，进行Swagger2的集成。现在都奉行前后端分离开发和微服务大行其道，分微服务及前后端分离后，前后端开发的沟通成本就增加了。所以一款强大的RESTful API文档就至关重要了。而目前在后端领域，基本上是Swagger的天下了。

Swagger2介绍

Swagger是一款RESTful接口的文档在线自动生成、功能测试功能框架。一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务，加上swagger-ui，可以有很好的呈现。

swagger首页

SpringBoot集成

这里选用的swagger版本为：2.8.0

0.pom依赖


        
            
     
      io.springfox
             
     
      springfox-swagger2
             
     
      2.8.0
         
        
            
     
      io.springfox
             
     
      springfox-swagger-ui
             
     
      2.8.0

1.编写配置文件(Swagger2Config.java)

主要是添加注解@EnableSwagger2和定义Docket的bean类。

@EnableSwagger2@Configurationpublic class SwaggerConfig {    //是否开启swagger，正式环境一般是需要关闭的，可根据springboot的多环境配置进行设置    @Value(value = "${swagger.enabled}")    Boolean swaggerEnabled;    @Bean    public Docket createRestApi() {        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())                // 是否开启                .enable(swaggerEnabled).select()                // 扫描的路径包                .apis(RequestHandlerSelectors.basePackage("cn.lqdev.learning.springboot.chapter10"))                // 指定路径处理PathSelectors.any()代表所有的路径                .paths(PathSelectors.any()).build().pathMapping("/");    }    private ApiInfo apiInfo() {        return new ApiInfoBuilder()                .title("SpringBoot-Swagger2集成和使用-demo示例")                .description("oKong | 趔趄的猿")                // 作者信息                .contact(new Contact("oKong", "https://blog.lqdev.cn/", "499452441@qq.com"))                .version("1.0.0")                .build();    }}

3.添加文档内容(一般上是在Controller，请求参数上进行注解，这里以上章节的UserController进行配置)

UserController

/** * 用户控制层 简单演示增删改查及分页 * 新增了swagger文档内容 2018-07-21 * @author oKong * */@RestController@RequestMapping("/user")@Api(tags="用户API")public class UserController {    @Autowired    IUserService userService;        @PostMapping("add")    @ApiOperation(value="用户新增")    //正常业务时， 需要在user类里面进行事务控制，控制层一般不进行业务控制的。    //@Transactional(rollbackFor = Exception.class)    public Map
    
      addUser(@Valid @RequestBody UserReq userReq){                User user = new User();        user.setCode(userReq.getCode());        user.setName(userReq.getName());        //由于设置了主键策略 id可不用赋值 会自动生成        //user.setId(0L);        userService.insert(user);        Map
     
       result = new HashMap
      
       ();        result.put("respCode", "01");        result.put("respMsg", "新增成功");        //事务测试        //System.out.println(1/0);        return result;    }        @PostMapping("update")    @ApiOperation(value="用户修改")        public Map
       
         updateUser(@Valid @RequestBody UserReq userReq){                if(userReq.getId() == null || "".equals(userReq.getId())) {            throw new CommonException("0000", "更新时ID不能为空");        }        User user = new User();        user.setCode(userReq.getCode());        user.setName(userReq.getName());        user.setId(Long.parseLong(userReq.getId()));                userService.updateById(user);        Map
        
          result = new HashMap
         
          (); result.put("respCode", "01"); result.put("respMsg", "更新成功"); return result; } @GetMapping("/get/{id}") @ApiOperation(value="用户查询(ID)") @ApiImplicitParam(name="id",value="查询ID",required=true) public Map
          
            getUser(@PathVariable("id") String id){ //查询 User user = userService.selectById(id); if(user == null) { throw new CommonException("0001", "用户ID：" + id + "，未找到"); } UserResp resp = UserResp.builder() .id(user.getId().toString()) .code(user.getCode()) .name(user.getName()) .status(user.getStatus()) .build(); Map
           
             result = new HashMap
            
             (); result.put("respCode", "01"); result.put("respMsg", "成功"); result.put("data", resp); return result; } @GetMapping("/page") @ApiOperation(value="用户查询(分页)") public Map
             
               pageUser(int current, int size){ //分页 Page
              
                page = new Page<>(current, size); Map
               
                 result = new HashMap
                
                 (); result.put("respCode", "01"); result.put("respMsg", "成功"); result.put("data", userService.selectPage(page)); return result; } }

UserReq.java

@Data@Builder@NoArgsConstructor@AllArgsConstructor//加入@ApiModel@ApiModelpublic class UserReq {        @ApiModelProperty(value="ID",dataType="String",name="ID",example="1020332806740959233")    String id;        @ApiModelProperty(value="编码",dataType="String",name="code",example="001")    @NotBlank(message = "编码不能为空")    String code;        @ApiModelProperty(value="名称",dataType="String",name="name",example="oKong")    @NotBlank(message = "名称不能为空")    String name;}

Swagger访问与使用

api首页路径：http://127.0.0.1:8080/swagger-ui.html

调试：点击需要访问的api列表，点击try it out!按钮，即可弹出一下页面：

Try it out!

执行：

Execute

结果：

大家可下载示例，查看自定义的字符出现的位置，这样可以对其有个大致了解，各字段的作用领域是哪里。

Swagger常用属性说明

作用范围	API	使用位置
对象属性	@ApiModelProperty	用在出入参数对象的字段上
协议集描述	@Api	用于controller类上
协议描述	@ApiOperation	用在controller的方法上
Response集	@ApiResponses	用在controller的方法上
Response	@ApiResponse	用在 @ApiResponses里边
非对象参数集	@ApiImplicitParams	用在controller的方法上
非对象参数描述	@ApiImplicitParam	用在@ApiImplicitParams的方法里边
描述返回对象的意义	@ApiModel	用在返回对象类上

常用的注解@Api、@ApiOperation、@ApiModel、@ApiModelProperty示例中有进行标注，对于其他注解，大家可自动谷歌，毕竟常用的就这几个了。有了swagger之后，原本一些post请求需要postman这样的调试工具来进行发起，而现在直接在页面上就可以进行调试了，是不是很爽！对于服务的调用者而已，有了这份api文档也是一目了然，不需要和后端多少沟通成本，按着api说明进行前端开发即可。

总结

本章节主要是对Swagger的集成和简单使用进行了说明，详细的用法，可自行搜索相关资料下，这里就不阐述了。因为对于百分之八十之上的文档要求基本能满足了。一些比如前端根据swagger的api-docs进行前端的快速开发，这就需要实际情况实际约定了，比如快速的生成表单页等也是很方便的事情。最后，强烈建议在生产环境关闭swagger,避免不必要的漏洞暴露！

最后

目前互联网上很多大佬都有SpringBoot系列教程，如有雷同，请多多包涵了。本文是作者在电脑前一字一句敲的，每一步都是实践的。若文中有所错误之处，还望提出，谢谢。

老生常谈

个人QQ：499452441

微信公众号：lqdevOps

公众号

个人博客：

完整示例：

原文地址：

转载于:https://www.cnblogs.com/okong/p/springboot-ten.html

你可能感兴趣的文章