Swagger的使用

刚开始学java的时候，各种学习都是匆忙，能够尽快进入项目开发，没有总结之前学习的，后来重新自己创建项目，发现之前学的还是需要总结一下。
1.认识Swagger
Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。
2.首先在pom.xml中添加依赖

<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>

2.创建swagger2配置类

• 在与spring boot集成时， 放在与启动Application.java同级的目录下在同一个目录下。
• 通过@Configuration注解，让Spring来加载该类配置
• 通过@EnableSwagger2注解来启用Swagger2
  下面是我自己写的简单的配置类，仅供参考

package com.redisdemo.demo;

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 Swagger2Config {
    @Bean
    public Docket buildDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())//调用下面apiInfo()方法
                .select()
                //Controller所在路径
                .apis(RequestHandlerSelectors.basePackage("com.redisdemo.demo"))
                .paths(PathSelectors.any())
                .build();

    }

    public ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("springboot结合swagger2构建Restful API")
                .description("这是一个swagger2小型demo22")
                .termsOfServiceUrl("www.baidu.com")
                .contact("hwh")
                .version("0.0.1")
                .build();

    }
}

特别注意以上说明的两个注解。其他开发中需要的注解慢慢学习应用

@Api：用在类上，说明该类的作用。

@ApiOperation：注解来给API增加方法说明。

@ApiImplicitParams : 用在方法上包含一组参数说明。

@ApiImplicitParam：用来注解来给方法入参增加说明。

@ApiResponses：用于表示一组响应

@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息

  l   code：数字，例如400

  l   message：信息，例如"请求参数没填好"

  l   response：抛出异常的类   

@ApiModel：描述一个Model的信息（一般用在请求参数无法使用@ApiImplicitParam注解进行描述的时候）

  l   @ApiModelProperty：描述一个model的属性

完成配置之后，运行项目，访问地址：http://localhost:8080/swagger-ui.html，这里并不一定是8080，要看你自己配置的接口是多少，还有localhost可以换成开发中的测试环境，开发环境等等。
以下是我大致访问的界面：

image.png