Swagger

2019-12-14

Swagger接口生成工作原理：

系统启动，扫描到api工程中的Swagger2Configuration类
在此类中指定了包路径com.xuecheng，找到在此包下及子包下标记有@RestController注解的controller类
根据controller类中的Swagger注解生成接口文档。

快速入门

1.创建Swagger配置类

package com.xuecheng.api.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//开启Swagger, 加上这个注解之后会自动扫描"com.xuecheng"包下所有的@RestController注解
public class Swagger2Configuration {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xuecheng"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("学成网api文档")
                .description("学成网api文档")
               	//.termsOfServiceUrl("/")
                .version("1.0")
                .build();
    }

}

2.接口上声明注解, 方法上也声明注解, 参数也声明注解

package com.xuecheng.api.cms;

//如果接口上有个注解会被Swagger扫描到
@Api(value = "页面管理接口",description = "cms页面管理接口，提供页面的增、删、改、查")
public interface CmsPageControllerApi {

    @ApiOperation("页面列表分页查询")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "page",value = "页码",required = true,paramType = "path",dataType = "int"),
            @ApiImplicitParam(name = "size",value = "每页记录数",required = true,paramType = "path",dataType = "int")
    })
    public QueryResponseResult findList(int page, int size, QueryPageRequest queryPageRequest);

}

3.pojo中声明注解

package com.xuecheng.framework.domain.cms.request;

import com.xuecheng.framework.model.request.RequestData;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

/**
 * 查询条件类型
 * 请求类型统一继承RequestData类型
 */
@Data
public class QueryPageRequest extends RequestData {
    // 站点id
    @ApiModelProperty("站点id")
    private String siteId;

    // 页面ID
    @ApiModelProperty("页面ID")
    private String pageId;

    // 页面名称
    @ApiModelProperty("页面名称")
    private String pageName;

    // 别名
    @ApiModelProperty("别名")
    private String pageAliase;

    // 模版id
    @ApiModelProperty("模版id")
    private String templateId;
}

4.启动类上面要加上包扫描@ComponentScan(basePackages={“com.xuecheng.api”})

实际上在启动类上加上@EnableSwagger2注解也可以, 但是没有一些配置了

package com.xuecheng.manage_cms;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.domain.EntityScan;
import org.springframework.context.annotation.ComponentScan;

@SpringBootApplication//声明是一个启动类
@EntityScan("com.xuecheng.framework.domain.cms")//扫描实体类
@ComponentScan(basePackages={"com.xuecheng.api"})//扫描接口
@ComponentScan(basePackages={"com.xuecheng.manage_cms"})//扫描本项目下的所有类, 不能省略不写
public class ManageCmsApplication {
    public static void main(String[] args) {
        SpringApplication.run(ManageCmsApplication.class,args);
    }
}

5.测试

启动cms服务工程，查看接口文档，请求：http://localhost:31001/swagger-ui.html

>server:
 port: ${PORT:31001}
>spring:
 application:
   name: xc-service-manage-cms
 data:
   mongodb:
     #uri:  mongodb://root:123@localhost:27017, 我设置的密码是root
     uri: mongodb://root:root@localhost:27017
     database: xc_cms

5.Swagger常用注解

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

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

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

@ApiParam：单个参数描述

@ApiModel：用对象来接收参数

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

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

@ApiResponses：HTTP响应整体描述

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

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

@ApiImplicitParam：一个请求参数

@ApiImplicitParams：多个请求参数

@ApiImplicitParam属性：

属性	取值	作用
paramType		查询参数类型
	path	以地址的形式提交数据
	query	直接跟参数完成自动映射赋值
	body	以流的形式提交仅支持POST
	header	参数在request headers 里边提交
	form	以form表单的形式提交仅支持POST
dataType		参数的数据类型只作为标志说明，并没有实际验证
	Long
	String
name		接收参数名
value		接收参数的意义描述
required		参数是否必填
	true	必填
	false	非必填
defaultValue		默认值

本文作者： 夏虫语冰
发布时间： 2019-12-14
最后更新： 2019-12-15
本文标题： Swagger
本文链接： https://shiyongxu.github.io/2019/12/14/Swagger/
版权声明： 本作品采用 CC BY-NC-SA 4.0 许可协议进行许可。转载请注明出处！