Swagger

最新推荐文章于 2024-11-28 02:04:25 发布

uh239

最新推荐文章于 2024-11-28 02:04:25 发布

阅读量347

点赞数

文章标签：前端 postman java

本文链接：https://blog.youkuaiyun.com/weixin_66387650/article/details/125315312

版权

Swagger

项目集成Swagger

官网地址：API Documentation & Design Tools for Teams | Swagger

学习目标：

了解Swagger的概念及作用
掌握在项目中集成Swagger自动生成API文档

前后端分离好处：

一、Swagger

号称世界上最流行的Api框架
RestFul Api 文档在线自动生成工具，Api文档与Api定义同步更新
直接运行，可以在线测试API接口
支持多种语言：（Java,php等）

官网：API Documentation & Design Tools for Teams | Swagger

了解Swagger的概念及作用
掌握在项目中集成Swag

Swagger简介

前后端分离
后端时代：前端值用管理静态页面；html==>后端。模板引擎jsp==>后端是主力

前后端分离时代：
后端：后端控制层，服务层，数据访问层【后端团队】
前端：前端控制层，视图层【前端团队】
1. 前端可以自定义一些伪后端数据：json,在写的时候就存在，不需要后端，前端工程依旧能够跑起来
那么前端后端如何交互？
此时我们可以考虑API
前后端相对独立，松耦合
前后端设置可以部署在不同的服务器上
前后端集成，前端或者后端无法做到“及时协商，尽早解决”，最终导致问题集中爆发
首先定义schema [ 计划的提纲 ]，并实时跟踪最新的API，降低集成风险
早期：指定word计划文档
前后端分离时期：

前端测试后端接口：postman

后端提供接口，需要实时更新最新的消息及改动
ger自动生成API文档
号称世界上最流行的Api框架
RestFul Api 文档在线自动生成工具，Api文档与Api定义同步更新
直接运行，可以在线测试API接口
支持多种语言：（Java,php等）

二、SpringBoot集成Swagger

导入相关依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        
        <!-- 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>

3.编写一个Hello工程

@RestController
public class HelloController {
    @RequestMapping(value = "/hello")
    public String hello(){
        return "hello";
    }
}

4.配置Swagger

@Configuration
@EnableSwagger2 //开启Swagger2
public class SwaggerConfig {

}

5.进入测试

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

三、配置Swangger信息

1、Swagger实例Bean是Docket，所以通过配置Docket实例来配置Swaggger。

  @Bean //配置Swagger的docket的Bean实列
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2);
    }

2、可以通过apiInfo()属性配置文档信息

//配置Swagger2信息 = apiInfo
    private ApiInfo apiInfo(){
        //作者信息                            联系人名称            联系人访问地址                                 联系人邮箱
        Contact contact = new Contact("冯宝宝","https://blog.youkuaiyun.com/qq_45511798?type=blog","fjq229@foxmail.com");
        return new ApiInfo(
                "冯宝宝的SwaggerAPI文档",        //标题
                "在实践中学习",            //描述
                "1.0",                      //版本
                "https://blog.youkuaiyun.com/qq_45511798?type=blog",       //组织链接
                contact,                           //联系人信息
                "Apache 2.0",               //许可
                "http://www.apache.org/licenses/LICENSE-2.0",   //许可链接
                new ArrayList<VendorExtension>()                         //扩展
        );
    }

3、Docket 实例关联上 apiInfo()

@Bean //配置Swagger的docket的Bean实列
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo());
    }

4、重启项目，访问测试 http://localhost:8080/swagger-ui.html

看下效果；

四、Swangger配置扫描接口

1、构建Docket时通过select()方法配置怎么扫描接口。

@Bean //配置Swagger的docket的Bean实列
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
                //basePackage:指定扫描的包
                //any():扫描全部
                //none():不扫描
                .apis(RequestHandlerSelectors.basePackage("com.lxyk.controller"))
                //paths():过滤扫描路劲
                //.paths(PathSelectors.any(""))
                .build();
    }

2、重启项目测试，由于我们配置根据包的路径扫描接口，所以我们只能看到一个类

3、除了通过包路径配置扫描接口外，还可以通过配置其他方式扫描接口，这里注释一下所有的配置方式：

basePackage(final String basePackage) // 根据包路径扫描接口
any() // 扫描所有，项目中的所有接口都会被扫描到
none() // 不扫描接口
// 通过方法上的注解扫描，如withMethodAnnotation(GetMapping.class)只扫描get请求
withMethodAnnotation(final Class<? extends Annotation> annotation)
// 通过类上的注解扫描，如.withClassAnnotation(Controller.class)只扫描有controller注解的类中的接口
withClassAnnotation(final Class<? extends Annotation> annotation)

4、除此之外，我们还可以配置接口扫描过滤：

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .select()
      .apis(RequestHandlerSelectors.basePackage("com.lxyk.controller"))
       // 配置如何通过path过滤,即这里只扫描请求以/ss开头的接口
      .paths(PathSelectors.ant("/ss/**"))
      .build();
}

5、这里的可选值还有

any() // 任何请求都扫描
none() // 任何请求都不扫描
regex(final String pathRegex) // 通过正则表达式控制
ant(final String antPattern) // 通过ant()控制

五、配置Swagger开关

1、通过enable()方法配置是否启用swagger，如果是false，swagger将不能在浏览器中访问了

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .enable(false) //配置是否启用Swagger，如果是false，在浏览器将无法访问
      .select()
      .apis(RequestHandlerSelectors.basePackage("com.lxyk.controller"))
      .build();
}

我只希望我的Swagger在生产环境使用，在发布的时候不使用？

判断是不是生产环境 flag = false
注入enable （flag）

application.properties

spring.profiles.active=dev.

pro测试环境

application-pro.properties

server.port=8082

2、如何动态配置当项目处于test、dev环境时显示swagger，处于prod时不显示？

@Bean //配置Swagger的docket的Bean实列
    public Docket docket(Environment environment) {

        // 设置要显示swagger的环境
        Profiles of = Profiles.of("dev", "test");
        // 判断当前是否处于该环境
        // 通过 enable() 接收此参数判断是否要显示
        boolean b = environment.acceptsProfiles(of);


        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(b)                  //配置是否启用Swagger，如果是false，在浏览器将无法访问
                .select()
                //通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
                //basePackage:指定扫描的包
                //any():扫描全部
                //none():不扫描
                .apis(RequestHandlerSelectors.basePackage("com.lxyk.controller"))
                .build();
    }

把：application.properties改一下

访问：http://localhost:8082/swagger-ui.html

六、配置API分组

@Bean
public Docket docket1(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("group1");
}
@Bean
public Docket docket2(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("group2");
}
@Bean
public Docket docket3(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("group3");
}

七、实体配置

1、新建一个实体类

//@Api("注释")
@ApiModel("用户实体类")
@Data
@EqualsAndHashCode
@AllArgsConstructor
@NoArgsConstructor
public class User {
    @ApiModelProperty("用户名")
    private String username;
    @ApiModelProperty("密码")
    private String password;
}

2、只要这个实体在请求接口的返回值上（即使是泛型），都能映射到实体项中：

3、重启项目查看.

八、常用注解

Swagger的所有注解定义在io.swagger.annotations包下

下面列一些经常用到的，未列举出来的可以另行查阅说明：.

Swagger注解	简单说明
@Api(tags="xxx模块说明")	作用在模块类上
@ApiOperation("xxx接口说明")	作用在接口方法上
@ApiModel("xxxPOJO说明")	作用在模型上：如VO,BO
@ApiModelProperty(value="xxx属性说明"，hidden=true)	作用在类方法和属性上，hidd设置为true可以隐藏该属性
@ApoParam("xxx参数说明")	作用在参数，方法和字段上，类似@ApiModelProperty

我们也可以给请求的接口配置一些注释

1、在HelloWorld控制类中的接口添加api接口注释

 @ApiOperation("Hello控制接口")
    @GetMapping("/hello2")
    public String hello2(@ApiParam("用户名") String username) {
        return "hello" + username;
    }

    @ApiOperation("get测试")
    @GetMapping("/get")
    public User getUser(@ApiParam("用户") User user) {
        return user;
    }

2.进行try it out测试

拓展：其他皮肤

我们可以导入不同的包实现不同的皮肤定义：

1:导入不同依赖

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

<dependency>
<groupId>com.github.caspar-chen</groupId>
<artifactId>swagger-ui-layer</artifactId>
<version>1.1.3</version>
</dependency>

<dependency>
<groupId>com.zyplayer</groupId>
<artifactId>swagger-mg-ui</artifactId>
<version>1.0.6</version>
</dependency>