[Java知识库]前言技术.swagger

一、swagger的介绍

1. 前后端分离的特点

前后端分离是的前端与后端之间的职责更加明确

? ·? 后台： 负责业务处理

? ·? 前端： 负责显示逻辑

在这种情况下，前端和后端可以分别交付给专业的开发人员去做，所以是必须要定义前后端直接的对接接口，否则各自为是则项目无法集成，这时就需要一个文档来定义统一的接

2. 在没有 swagger 之前

在没有 swagger 之间，我们可以使用 word ， excel 等功能来书写接口定义文档，但又有一个弊端，即： 在接口发送改变时需要及时的同步接口文档，否则实际的接口与接口文档不相符，则接口文件就失去了作用，甚至会起到反作用。

3. swagger 的作用

根据在代码中使用自定义的注解来生成接口文档，这个在前后端分离的项目中很重要。这样做的好处是在开发接口时可以通过swagger 将接口文档定义好，同时也方便以后的维护

4. swagger 的优点

? · 号称时最流行的 API 框架

? · 接口文档在线生成，避免同步的麻烦

? · 可以支持在线对接口执行测试

? · 支持多语言

5、集成swagger

①、新建springboot项目

（1）. 打开https://mvnrepository.com/search?q=springfox&__cf_chl_f_tk=Q6B.I0nVgxSaKl9ZtlljJ0qx.shGqrsOZ1OZ6NxN.ks-1646986792-0-gaNycGzNCL0

查找springbox，在pom.xml中导入如下图标出的依赖。

?（2）导入pom依赖

 <!-- 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>

③、编写swagger的配置类

（1）新建config包，新建SwaggerConfig 类

package com.mwy.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.mwy.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("Mi")
                .description("商城")
                .version("1.0")
                .termsOfServiceUrl("https://www.mwy.com")
                .build();
    }

}

注意： 该配置类需要根据自己的项目修改，如以下配置

? · paths 指定需要生成文档的 url 规则

? · title 文档标题

? · description 描述

（2）浏览器访问查看

?④、开发一个controller用于测试

package com.mwy.controller;

import com.mwy.pojo.User;
import com.mwy.service.IUserService;
import com.mwy.util.response.ResponseResult;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

@RequestMapping("/user")
@RestController
@Api(tags = "用户操作类")
public class UserController {

    @Autowired
    private IUserService userService;

    @ApiOperation(value = "登录方法")
    @ApiImplicitParam(value = "用户信息",required = true,name = "user",paramType = "boby")
    @RequestMapping(value = "/login",method = RequestMethod.POST )
    public ResponseResult<?> login(@RequestBody User user) {
        return userService.findUserByAccount(user);
    }

}

??说明集成成功

6、swagger常用注解

header 请求参数的获取： @RequestHeader

query 请求参数的获取： @RequestParam

path （用于 restful 接口） 请求参数的获取： @PathVariable

body （不常用）

form （不常用）

②、将用户实体类增加注解

package com.mwy.pojo;

import com.fasterxml.jackson.annotation.JsonFormat;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;
import org.springframework.format.annotation.DateTimeFormat;

import javax.persistence.*;
import java.io.Serializable;
import java.time.LocalDateTime;

@Data
@Table(name = "t_user")
@AllArgsConstructor
@NoArgsConstructor
@Accessors(chain = true)
@ApiModel(description = "用户实体类")
public class User implements Serializable {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @ApiModelProperty(value = "用户ID",name = "id",example = "0")
    private Long id;

    @ApiModelProperty(value = "用户账号",name = "account")
    private String account;

    @ApiModelProperty(value = "用户密码",name = "password")
    private String password;

    @ApiModelProperty(value = "修改时间",name = "modifyTime",example = "2021-02-02 12:00:00")
    @Column(name = "modify_time")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime modifyTime;

    @ApiModelProperty(value = "创建时间",name = "createTime",example = "2021-01-01 12:00:00")
    @Column(name = "create_time")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime createTime;

}

结果：

?