如何使⽤用Swagger-UI进⾏行行测试

喜欢ヅ旅行 2021-11-16 06:46 207阅读 0赞

1.在POM⽂文件增加⽂文件依赖，⼀一般在搭建⼯工程时，都会添加上，不不需要每个开发⼈人员都做这⼀一步操作,如下:

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

</dependency>
     <dependency>

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

</dependency>

2.在接⼝口类上增API注解，代码⽣生成器器⽣生成的类上都已经⽣生成，⾃自定义的接⼝口类上需要增加,如下:

@Api(tags = "VflBrandController",description = "品牌接⼝口") @RestController  
public class VflBrandController extends LeaseBaseController \{

此处tags标记是哪个接⼝口类，description是接⼝口类说明。 3.在接⼝口⽅方法上增加注解，代码⽣生成器器⽣生成的类上都已经⽣生成，⾃自定义的接⼝口类上需要增加,如下:

@ApiOperation(notes = "参数说明",value = "⽅方法说明-查询所有品牌信息") @RequestMapping(value = "vflBrand/getVflBrandAll", method = \{RequestMethod.POST, R equestMethod.GET \})  
public @ResponseBody Result getVflBrandAll(@RequestBody Map<String,Object> paramMa p) \{  
\}

4.如果接⼝口参数是个实体类，需要在实体类上增加注解ApiModel,在类中属性上增加注解ApiModelProperty， 代码⽣生成器器⽣生成的类上都已经⽣生成，⾃自定义的接⼝口类上需要增加,如下:

@ApiModel("品牌查询参数扩展实体")  
public class VflBrandQueryExtend extends VflBrandQuery \{

@ApiModelProperty("ID") private String id;  
/\*\* 品牌编码 \*\*/ @ApiModelProperty("品牌编码") private String brandCode; /\*\* 品牌名称 \*\*/ @ApiModelProperty("品牌名称") private String brandName;

5.接⼝口参数可以使⽤用注解ApiParam，代码⽣生成器器⽣生成的类上都已经⽣生成，⾃自定义的接⼝口类上需要增加，如 下:

6.增加系统配置类，如何在启动类中没有加⼊入，需要使⽤用注解Import引⼊入，⼀一般开发也不不需要配置，由统⼀一 ⼈人员配置，如下:

@Configuration
    @EnableSwagger2
    public class SwaggerConfig {

/\*\*  
\* 接⼝口访问域名 \*/

@Value("${swagger.domain}")
        private String swaggerDomain;

@Bean
        public Docket createRestApi() {

return new Docket(DocumentationType.SWAGGER_2)
                // .host("dev-test.service.imfbp.com")
                .host(swaggerDomain)
                .apiInfo(apiInfo())

.select()  
//扫描等接⼝口包 .apis(RequestHandlerSelectors.basePackage("com.imfbp.vfl")) .paths(PathSelectors.any())  
.build();

private ApiInfo apiInfo() {
            return new ApiInfoBuilder()

\} \}

.title("公共业务档案后台接⼝口") .description("公共业务档案后台接⼝口") .termsOfServiceUrl("http://www.imfbp.com") .version("1.0")

.build();

7.启动服务访问地址，⽐比如:  
地址 http://localhost:8080/imfbp-vfl-base-web/swagger-ui.html\#/ 可以看到界⾯面，如下:

<table> 
 <tbody> 
  <tr> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td> <pre>可以随便便打开⼀一个接⼝口，查询接⼝口参数，以及返回数据类型
</pre> <p>可以点击 Try it out 按钮，进⼊入如下界⾯面:</p> </td> 
  </tr> 
  <tr> 
   <td>&nbsp;</td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td> <p>然后编辑参数，点击Execute按钮进⾏行行测试，也可以点击Clear按钮清空参数，然后重新测试，或者点击 Cancel按钮，取消测试，如下:</p> <p>测试结果如下图:</p> </td> 
  </tr> 
  <tr> 
   <td>&nbsp;</td> 
  </tr> 
 </tbody> 
</table>

返回的状态码说明如下图:

8.总结⼀一下，每⼀一个接⼝口，做测试⼀一定要覆盖所有的分⽀支，保证代码覆盖率能够达到100%，就需要使⽤用不不同 的测试⽤用例例，swagger-ui⽀支持从浏览器器直接测试，针对前后端分离进⾏行行的开发模式，不不是每个接⼝口联调都需 要⼀一对⼀一坐着测试，我们应该更更多往PAI⽹网关⽅方⾯面靠近，后端接⼝口开发⼈人员应该写出清楚接⼝口调⽤用说明，保证 前端能够看得懂接⼝口说明，这样联调就可以节约时间，提⾼高效率，保证代码质量量。另外，要是时间允许，建 议⼤大家都可以JUnit单元测试代码，其实从更更多的⻆角度保证⾃自⼰己写的代码的正确性，有利利于提⾼高⼀一个产品的质 量量，很多时候不不是时间不不够，⽽而是你会不不会去这么做，积极主动做⼀一件事，⽐比被别⼈人要求做⼀一件事，会开⼼心 很多。

<table> 
 <tbody> 
  <tr> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td> <p>9.感谢您花时间阅读，也希望您未来⼀一切都好，事业蒸蒸⽇日上，身体健康，万事如意。</p> </td> 
  </tr> 
  <tr> 
   <td>&nbsp;</td> 
  </tr> 
 </tbody> 
</table>