Springboot集成Swagger2

目录

Springboot集成Swagger2

一、Swagger2 阐述

二、Swagger2 基础使用

三、相关注解

四、注意事项

五、shiro整合swagger

---

---

Springboot集成Swagger2

一、Swagger2 阐述

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

 作用：

    1. 接口的文档在线自动生成。

    2. 功能测试。

 Swagger是一组开源项目，其中主要要项目如下：

1.   Swagger-tools:提供各种与Swagger进行集成和交互的工具。例如模式检验、Swagger 1.2文档转换成Swagger 2.0文档等功能。

2.   Swagger-core: 用于Java/Scala的的Swagger实现。与JAX-RS(Jersey、Resteasy、CXF...)、Servlets和Play框架进行集成。

3.   Swagger-js: 用于JavaScript的Swagger实现。

4.   Swagger-node-express: Swagger模块，用于node.js的Express web应用框架。

5.   Swagger-ui：一个无依赖的HTML、JS和CSS集合，可以为Swagger兼容API动态生成优雅文档。

6.   Swagger-codegen：一个模板驱动引擎，通过分析用户Swagger资源声明以各种语言生成客户端代码。

二、Swagger2 基础使用

1.导包

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

2.加入配置类

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;

/**
 * swagger在线文档配置<br>
 * 项目启动后可通过地址：http://host:ip/swagger-ui.html 查看在线文档
 */
@Configuration  //在与spring boot集成时，通过@Configuration注解，让Spring来加载该类配置。
@EnableSwagger2 //启用Swagger2
public class Swagger2Configuration {

    /**
     * 创建API应用
     * apiInfo() 增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
     */
    @Bean
    public Docket adminDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("admin") //分组名称，随便取
                .apiInfo(adminApiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.yy.springbootdemo.controller"))  //需扫添加到swagger上的全限定名
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 创建该API的基本信息（这些基本信息会展现在文档页面中）
     */
    private ApiInfo adminApiInfo() {
        return new ApiInfoBuilder()
                .title("spring-boot-demo API")      //该API的名称
                .description("ceshi swagger 的API")  //描述
                .termsOfServiceUrl("http://www.baidu.com")  //创建的路径，写不写都可以。
                //.contact("http://www.baidu.com")
                .version("1.0") //版本
                .build();
    }
}

3.使用

项目启动后可通过地址：http://host:ip/swagger-ui.html 查看在线文档

效果：

 

三、相关注解

在完成了上述配置后，其实已经可以生产文档内容，但是这样的文档主要针对请求本身，描述的主要来源是函数的命名，对用户并不友好，我们通常需要自己增加一些说明来丰富文档内容。

Swagger使用的注解及其说明：

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

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

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

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

@ApiResponses：用于表示一组响应，用在@ApiResponses里面

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

    l   code：数字，例如400

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

    l   response：抛出异常的类   

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

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

 

注意：@ApiImplicitParam的参数说明：

paramType：指定参数放在哪个地方	header：请求参数放置于Request Header，使用@RequestHeader获取 query：请求参数放置于请求地址，使用@RequestParam获取 path：（用于restful接口）-->请求参数的获取：@PathVariable body：（不常用） form（不常用）
name：参数名
dataType：参数类型
required：参数是否必须传	true | false
value：说明参数的意思
defaultValue：参数的默认值

如：

效果：

四、注意事项

1.controller上的方法，需要注明具体的RequestMethod类型，否则SawggerUi会默认为全类型皆可访问， API列表中会生成多条项目。

不注明效果如下：

2.@api注解使用

@Api(value = "这里不起作用",description = "这才是描述")

描述需要写在description 里边，写在value里面不起作用

3.@ApiModel注解使用

还需要步骤：

在字段上打注解：@ApiModelProperty作为字段的描述

方法上和类上添加注解

太麻烦没有实现，想研究的参考：https://blog.csdn.net/qq_32917699/article/details/81486060

 

五、shiro整合swagger

搭建项目后，使用shiro作为权限框架，必须对swagger设置放行，否则swagger无效。放行路径如下：

// 针对Swagger拦截放行
filterChainDefinitionMap.put("/swagger-ui.html", "anon");
filterChainDefinitionMap.put("/swagger/**", "anon");
filterChainDefinitionMap.put("/swagger-resources/**", "anon");
filterChainDefinitionMap.put("/v2/**", "anon");
filterChainDefinitionMap.put("/configuration/**", "anon");