接口测试、管理神器-Swagger

简介: 接口测试、管理神器-Swagger

**Swagger**

1) 号称世界上最流行的API框架。

2) RestFul API文档在线自动生成工具->Api文档与API定义同步更新。

3) 直接运行,可以在线测试API接口。


[swagger_demo(gitee),记得给个小星星哈!](https://gitee.com/xi_jing/Swagger_demo1)

[swagger_demo(github),记得给个小星星哈!](https://github.com/hnust-xijing/Swagger_demo1)


[swagger官网地址](https://swagger.io/)



在项目中使用Swagger需要springbox;

1) swagger2

2) ui


**SpringBoot集成Swagger**

1,新建一个springBoot Web项目

2,导入相关依赖


```xml

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->

<dependency>

   <groupId>io.springfox</groupId>

   <artifactId>springfox-swagger-ui</artifactId>

   <version>2.10.5</version>

</dependency>




<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->

<dependency>

   <groupId>io.springfox</groupId>

   <artifactId>springfox-swagger2</artifactId>

   <version>2.10.5</version>

</dependency>

```


3,编写一个Hello工程。

4,编写Swagger==>Config


```java

@Configuration

@EnableSwagger2  //开启Swagger2

public class SwaggerConfig {

}

```


5,测试运行


```java

http://localhost:8080/swagger-ui.html#/hello-controller

```

![在这里插入图片描述](https://ucc.alicdn.com/images/user-upload-01/20201002130056190.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ0OTY5NjQz,size_16,color_FFFFFF,t_70#pic_center)



**配置Swagger**

Swagger的bean实例Docket;


```java

package com.shuang.config;


import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

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;


import java.util.ArrayList;


@Configuration

@EnableSwagger2 //开启Swagger2

public class SwaggerConfig {


   //配置了swagger的docket的bean实例

   @Bean

   public Docket docket(){

       return new Docket(DocumentationType.SWAGGER_2)

               .apiInfo(apiInfo());

   }


   //配置swagger信息apiInfo

   private ApiInfo apiInfo() {


       Contact contack=new Contact("江爽","https://www.shishuangzhi.xyz","2894247242@qq.com");


       return new ApiInfo(

               "爽宝的Swagger API文档",

               "看到这个demo的人,能教我追妹子吗,有偿,微信号:js13617293003",

               "1.0",

               "https://www.shishuangzhi.xyz",

               contack,

               "Apache 2.0",

               "http://www.apache.org/license/LICENSE-2.0",

                new ArrayList()

       );

   }



}

```

**Swagger配置扫描接口**

Docket.select()


```java

//配置了swagger的docket的bean实例

@Bean

public Docket docket(){

   return new Docket(DocumentationType.SWAGGER_2)

           .apiInfo(apiInfo())

           .select()

           //RequestHandlerSelectors,配置要扫描接口的方式

           //basePackage:指定要扫描的包

           //any():扫描全部

           //none():不扫描

           //withclassAnnotation:扫描类上的注解

           .apis(RequestHandlerSelectors.basePackage("com.shuang.controller"))

           //paths(),过滤什么路径

           .paths(PathSelectors.ant("/shuang/**"))

           .build();

}

```


我只希望我的Swagger在生产环境中使用,在发布的时候不使用?

1)判断是不是生产环境 flag=false

2)注入enable(flag)


```java

//配置了swagger的docket的bean实例

//core.env结尾的

@Bean

public Docket docket(Environment environment){


   //设置要显示的Swagger环境

   Profiles profiles=Profiles.of("dev","test");


   //获取项目的环境

   //通过environment.acceptsProfiles判断是否处于自己设置的环境中。

   boolean flag = environment.acceptsProfiles(profiles);



   return new Docket(DocumentationType.SWAGGER_2)

           .apiInfo(apiInfo())

           .enable(flag)//enable是否启动Swagger,如果为false,则Swagger不能在浏览器中访问。

           .select()

           //RequestHandlerSelectors,配置要扫描接口的方式

           //basePackage:指定要扫描的包

           //any():扫描全部

           //none():不扫描

           //withclassAnnotation:扫描类上的注解

           .apis(RequestHandlerSelectors.basePackage("com.shuang.controller"))

           //paths(),过滤什么路径

           .paths(PathSelectors.ant("/shuang/**"))

           .build();

}

```


**配置API文档的分组**

.groupName("爽宝")


如何配置多个分组;多个Docket实例即可。


```java

@Bean

public Docket docket1(){

   return new Docket(DocumentationType.SWAGGER_2).groupName("A");

}

@Bean

public Docket docket2(){

   return new Docket(DocumentationType.SWAGGER_2).groupName("B");

}

@Bean

public Docket docket3(){

   return new Docket(DocumentationType.SWAGGER_2).groupName("C");

}

@Bean

public Docket docket4(){

   return new Docket(DocumentationType.SWAGGER_2).groupName("D");

}

```



![在这里插入图片描述](https://ucc.alicdn.com/images/user-upload-01/20201002130119534.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ0OTY5NjQz,size_16,color_FFFFFF,t_70#pic_center)



实体类


```java

package com.shuang.pojo;


import io.swagger.annotations.ApiModel;

import io.swagger.annotations.ApiModelProperty;


@ApiModel("用户实体类")

public class User {


   @ApiModelProperty("用户名")

   public String username;


   @ApiModelProperty("密码")

   public String password;

}

```


controller


```java

package com.shuang.controller;


import com.shuang.pojo.User;

import io.swagger.annotations.ApiOperation;

import io.swagger.annotations.ApiParam;

import org.springframework.web.bind.annotation.GetMapping;

import org.springframework.web.bind.annotation.PostMapping;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;


@RestController

public class HelloController {


   @GetMapping("/hello")

   public String hello(){

       return "hello";

   }


   //主要我们的接口中,返回值中存在实体类,他就会被扫描到Swagger中。

   @PostMapping("/user")

   public User user(){

       return new User();

   }

   //Operation接口,不是放在类上的,是方法

   @ApiOperation("Hello控制类")

   @GetMapping("/hello2")

   public String hello2(@ApiParam("用户名") String username){

       return "hello"+username;


   }


   @ApiOperation("post测试类")

   @PostMapping("/postt")

   public User hello3(@ApiParam("用户名") User user){

       return user;


   }

}

```


总结:

1,我们可以通过Swagger给一些比较难理解的属性或者接口,增加注释信息。

2,接口文档实时更新。

3,可以在线测试。

Swagger是一个优秀的工具,几乎所有大公司都有使用它。

【注意点】在正式发布的时候,关闭Swagger!!出于安全,也节约内存。













目录
相关文章
|
5天前
|
JSON 前端开发 API
以项目登录接口为例-大前端之开发postman请求接口带token的请求测试-前端开发必学之一-如果要学会联调接口而不是纯写静态前端页面-这个是必学-本文以优雅草蜻蜓Q系统API为实践来演示我们如何带token请求接口-优雅草卓伊凡
以项目登录接口为例-大前端之开发postman请求接口带token的请求测试-前端开发必学之一-如果要学会联调接口而不是纯写静态前端页面-这个是必学-本文以优雅草蜻蜓Q系统API为实践来演示我们如何带token请求接口-优雅草卓伊凡
29 5
以项目登录接口为例-大前端之开发postman请求接口带token的请求测试-前端开发必学之一-如果要学会联调接口而不是纯写静态前端页面-这个是必学-本文以优雅草蜻蜓Q系统API为实践来演示我们如何带token请求接口-优雅草卓伊凡
|
7天前
|
JSON 前端开发 测试技术
大前端之前端开发接口测试工具postman的使用方法-简单get接口请求测试的使用方法-简单教学一看就会-以实际例子来说明-优雅草卓伊凡
大前端之前端开发接口测试工具postman的使用方法-简单get接口请求测试的使用方法-简单教学一看就会-以实际例子来说明-优雅草卓伊凡
51 10
大前端之前端开发接口测试工具postman的使用方法-简单get接口请求测试的使用方法-简单教学一看就会-以实际例子来说明-优雅草卓伊凡
|
1月前
|
数据可视化 前端开发 测试技术
接口测试新选择:Postman替代方案全解析
在软件开发中,接口测试工具至关重要。Postman长期占据主导地位,但随着国产工具的崛起,越来越多开发者转向更适合中国市场的替代方案——Apifox。它不仅支持中英文切换、完全免费不限人数,还具备强大的可视化操作、自动生成文档和API调试功能,极大简化了开发流程。
|
1月前
|
存储 测试技术 数据库
接口测试工具攻略:轻松掌握测试技巧
在互联网快速发展的今天,软件系统的复杂性不断增加,接口测试工具成为确保系统稳定性的关键。它如同“翻译官”,模拟请求、解析响应、验证结果、测试性能并支持自动化测试,确保不同系统间信息传递的准确性和完整性。通过Apifox等工具,设计和执行测试用例更加便捷高效。接口测试是保障系统稳定运行的第一道防线。
|
1月前
|
Web App开发 JSON 测试技术
API测试工具集合:让接口测试更简单高效
在当今软件开发领域,接口测试工具如Postman、Apifox、Swagger等成为确保API正确性、性能和可靠性的关键。Postman全球闻名但高级功能需付费,Apifox则集成了API文档、调试、Mock与自动化测试,简化工作流并提高团队协作效率,特别适合国内用户。Swagger自动生成文档,YApi开源但功能逐渐落后,Insomnia界面简洁却缺乏团队协作支持,Paw仅限Mac系统。综合来看,Apifox是国内用户的理想选择,提供中文界面和免费高效的功能。
|
2月前
|
监控 JavaScript 测试技术
postman接口测试工具详解
Postman是一个功能强大且易于使用的API测试工具。通过详细的介绍和实际示例,本文展示了Postman在API测试中的各种应用。无论是简单的请求发送,还是复杂的自动化测试和持续集成,Postman都提供了丰富的功能来满足用户的需求。希望本文能帮助您更好地理解和使用Postman,提高API测试的效率和质量。
135 11
|
3月前
|
Java 测试技术 API
详解Swagger:Spring Boot中的API文档生成与测试工具
详解Swagger:Spring Boot中的API文档生成与测试工具
107 4
|
3月前
|
JSON Java 测试技术
SpringCloud2023实战之接口服务测试工具SpringBootTest
SpringBootTest同时集成了JUnit Jupiter、AssertJ、Hamcrest测试辅助库,使得更容易编写但愿测试代码。
92 3
|
4月前
|
JSON 算法 数据可视化
测试专项笔记(一): 通过算法能力接口返回的检测结果完成相关指标的计算(目标检测)
这篇文章是关于如何通过算法接口返回的目标检测结果来计算性能指标的笔记。它涵盖了任务描述、指标分析(包括TP、FP、FN、TN、精准率和召回率),接口处理,数据集处理,以及如何使用实用工具进行文件操作和数据可视化。文章还提供了一些Python代码示例,用于处理图像文件、转换数据格式以及计算目标检测的性能指标。
110 0
测试专项笔记(一): 通过算法能力接口返回的检测结果完成相关指标的计算(目标检测)
|
4月前
|
JavaScript 前端开发 API
vue尚品汇商城项目-day02【9.Home组件拆分+10.postman测试接口】
vue尚品汇商城项目-day02【9.Home组件拆分+10.postman测试接口】
67 0

热门文章

最新文章