swagger的使用---基础

什么是Swagger

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。
官网: https://swagger.io/

Swagger 的作用

支持 API 自动生成同步的在线文档：使用 Swagger 后可以直接通过代码生成文档，不再需要自己手动编写接口文档了，对程序员来说非常方便，可以节约写文档的时间去学习新技术。
提供 Web 页面在线测试 API：光有文档还不够，Swagger 生成的文档还支持在线测试。参数和格式都定好了，直接在界面上输入参数对应的值即可在线测试接口。

为什么使用swagger

因为现在是前后端分离式时代:
前端负责控制层，视图层有专门的前端团队。伪造后端数据，json。 已经存在了，不需要后端，前端工程依旧能够跑起来。
前后端如何交互? ===> API
前后端相对独立,松耦合;
前后端甚至可以部署在不同的服务器上;
但是因为前后端分离就产生一个问题：
前后端集成联调，前端人员和后端人员无法做到“即使协商，尽早解决"， 最终导致问题集中爆发;
要解决这个问题就需要前后端能够及时的沟通，这个时候就要用的swagger了。为

什么要用swagger呢？

• swagge号称世界上最流行的Api框架;
• RestFul Api文档在线自动生成工具=>Api文档与API定义同步更新
• 直接运行，可以在线测试API接口;
• 支持多种语言: (ava, Php…）

SpringBoot集成Swagger

SpringBoot集成Swagger
1.新建-个SpringBoot = web项目
2.导入相关依赖

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

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>

创建一个Swagger类

package com.example.demo1.config;


import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Description: 本类用于Swagger2配置
 * Created by 云 on 2019/12/26 11:51
 */
@Configuration
@EnableSwagger2 //开启Swagger2
public class swaggerConfig {

}

其实到了这一步Swagger已经开始工作了
可以使用 http://localhost:8080/swagger-ui.html#/
查看Swagger了

http://localhost:8080/swagger-ui.html#/

配置Swagger

package com.example.demo1.config;

import com.sun.javafx.scene.control.skin.PaginationSkin;
import io.swagger.annotations.*;
import javafx.print.PaperSource;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.ApiSelectorBuilder;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import javax.print.Doc;
import java.util.ArrayList;



/**
 * Description: 本类用于
 * Created by 云付宾 on 2019/12/26 11:51
 */
@Configuration
@EnableSwagger2 //开启Swagger2
public class swaggerConfig {

    @Bean
    public Docket docket(){
        return new  Docket(DocumentationType.SWAGGER_2).groupName("云")
                .apiInfo(apiInfo())
                //enable :是否启动swagger，false不启动，true启动
               // .enable(false)
                .select()
                /*RequestHandlerSelectors ：配置要扫描接口的方式
                 * basePackage() :扫描指定的包
                 * any() : 扫描全部
                 * none() : 不扫描
                 * withClassAnnotation() :扫描类上的注解，参数是一个注解的对象
                 * withMethodAnnotation() :扫描方法上的注解
                 */
                .apis(RequestHandlerSelectors.basePackage("com.example.demo1.controller"))
                //paths :过滤什么路径
//                .paths(PathSelectors.ant("com.example.demo1.controller/*"))
                .build()
                ;
    }

    private ApiInfo apiInfo(){
        //作者信息
        Contact DEFAULT_CONTACT = new Contact("云", "http://localhost:8085/", "123@qq.com");
        return new ApiInfo(
                "配置Swagger",
                "练习配置Swagger",
                "1.0",
                "urn:tos",
                DEFAULT_CONTACT,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList());
    }
}

Swagger里分组

在上面的代码中加入以下代码，就相当于多加入了A、B、C三组

    @Bean
    public Docket docket1(){
        return new  Docket(DocumentationType.SWAGGER_2).groupName("A");
    }
    @Bean
    public Docket docket2(){
        return new  Docket(DocumentationType.SWAGGER_2).groupName("B");
    }@Bean
    public Docket docket3(){
        return new  Docket(DocumentationType.SWAGGER_2).groupName("C");
    }
    

Swagger中常用的注释

@Api：用在请求的类上，表示对类的说明
    tags="说明该类的作用，可以在UI界面上看到的注解"
    value="该参数没什么意义，在UI界面上也看到，所以不需要配置"
    description ="描述"
    
@ApiOperation：用在请求的方法上，说明方法的用途、作用
    value="说明方法的用途、作用"
    notes="方法的备注说明"
    
@ApiParam 
	name	参数名称
	value	参数简单描述
	defaultValue	描述参数默认值
	allowableValues	可接收参数值限制，有三种方式,取值列表，取值范围
	required	是否为必传参数, false:非必传; true:必传
 
@ApiImplicitParams：用在请求的方法上，表示一组参数说明
    @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
        name：参数名
        value：参数的汉字说明、解释
        required：参数是否必须传
        paramType：参数放在哪个地方
            · header --> 请求参数的获取：@RequestHeader
            · query --> 请求参数的获取：@RequestParam
            · path（用于restful接口）--> 请求参数的获取：@PathVariable
            · body（不常用）
            · form（不常用）    
        dataType：参数类型，默认String，其它值dataType="Integer"       
        defaultValue：参数的默认值
 
@ApiResponses：用在请求的方法上，表示一组响应
    @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
        code：数字，例如400
        message：信息，例如"请求参数没填好"
        response：抛出异常的类
 
@ApiModel：用于响应类上，表示一个返回响应数据的信息
            （这种一般用在post创建的时候，使用@RequestBody这样的场景，
            请求参数无法使用@ApiImplicitParam注解进行描述的时候）
    @ApiModelProperty：用在属性上，描述响应类的属性

总结:

1.我们可以通过Swagger给一些比较难理解的属性或者接口， 增加注释信息
2.接口文档实时更新
3.可以在线测试
4.Swagger是一个优秀的工具，几乎所有大公司都有使用它
[注意点]在正式发布的时候，关闭Swagger! ! !出于安全考虑。而且节省运行的内存;