前言技术之swagger

一、swagger介绍

1. 前后端分离的特点

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

后台： 负责业务处理

前端： 负责显示逻辑

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

2. 在没有swagger之前

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

3. swagger的作用

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

4. swagger的优点

号称时最流行的API框架

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

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

支持多语言

二、集成swagger

打开https://mvnrepository.com/search?q=springfox

 查询springfox 导出下面那个的依赖

 <!-- 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的配置类

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

如以下配置

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

title 文档标题

description 描述

SwaggerConfig  

package com.smy.wx_web.config;


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.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()
                //扫描controller里面所有的类
                .apis(RequestHandlerSelectors.basePackage("com/smy/wx_web/controller"))
               //只要是请求就可以生成文档
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("顾北")
                .description("SwaggerDemo API DOC")
                .version("1.0")
                .termsOfServiceUrl("https://activate.navicat.com")
                .build();
    }

}

 

 访问成功

swagger常用注解

常用注解列表：

 

 

header 请求参数的获取：@RequestHeader query

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

请求参数的获取：@PathVariable body（不常用） form（不常用 

defaultValue="参数的默认值" required="true" 表示参数是否必须传 |

更全面的信息可以参考官方说明文档：swagger-annotations 1.3.10 API

实体类User 

package com.smy.wx_web.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)
@SuppressWarnings("all")
@ApiModel(description = "用户实体类")
public class User implements Serializable {


//    组件自增
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @ApiModelProperty(name = "id",value = "用户id",example = "0")
    private Long id;
    
    @ApiModelProperty(name = "account",value = "用户账号",example = "")
    private String account;

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

    @Column(name = "modify_time")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime modifyTime;

    @Column(name = "create_time")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime createTime;

}