接口自动生成工具---Swagger搭建

                    **

接口自动生成工具—Swagger搭建

**
最近学习了一些接口的测试小工具，今天开始总结一下吧！
swagger是一个比较简单的接口自动生成工具，可以在网页上就进行简单的接口的测试，不需要借助postman等工具。
1、需要导入相关的依赖

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

2、在一个工程中建立一个config文件夹，来放相关的配置类

package com.cast.admin.config;

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

//添加相关的注解
@Configuration
@EnableSwagger2
public class SwaggerConfiguration {

   @Bean
   public Docket buildDocket() {
      return new Docket(DocumentationType.SWAGGER_2)
              .apiInfo(buildApiInfo())
              .select()
              // 要扫描的API(Controller)基础包
              .apis(RequestHandlerSelectors.basePackage("com.cast"))
              .paths(PathSelectors.any())
              .build();
   }

   private ApiInfo buildApiInfo() {
   //作者的相关信息【名称、url、email】
      Contact contact = new Contact("swagger接口生成工具","","");
      //文档的描述信息
      return new ApiInfoBuilder()
              .title("swagger-自动接口平台管理API文档")
              .description("平台管理服务api")
              .contact(contact)
              .version("1.0.0").build();
   }
}

3、Swagger常用注解

在Java类中添加Swagger的注解即可生成Swagger接口文档，常用Swagger注解如下：

@Api：修饰整个类，描述Controller的作用

@ApiOperation：描述一个类的一个方法，或者说一个接口

@ApiParam：单个参数的描述信息

@ApiModel：用对象来接收参数

@ApiModelProperty：用对象接收参数时，描述对象的一个字段

@ApiResponse：HTTP响应其中1个描述

@ApiResponses：HTTP响应整体描述

@ApiIgnore：使用该注解忽略这个API

@ApiError ：发生错误返回的信息

@ApiImplicitParam：一个请求参数

@ApiImplicitParams：多个请求参数的描述信息

以下是我自己在自己的接口上，添加的相关注解，仅供参考

@Api(value = "频道管理", tags = "channel", description = "频道管理API")
public interface ChannelControllerApi {

    //关于分页查询+根据姓名查询
    @ApiOperation("频道分页列表查询")
    ResponseResult findByNameAndPage(ChannelDto dto);

@ApiModelProperty 注解的使用

4、之后启动自己的服务就能在网页上看到相关的数据了
网址：自己的域名+端口号+/swagger-ui.html/ 即可

关于使用说明：
1、点击Try it out 进行接口测试

2、输入相关的数据后，点击Execute

3、之后可以看到该接口返回的数据的状态码

关于swagger的搭建和使用基本上就是以上这些，希望可以帮助到大家！