功能亮点

  • API版本管理，变更通知，差异一目了然
  • API在线调试，可存测试用例，方便回归测试
  • 自动化测试可以编排，断言，可输出测试报告

API文档插件

安装天舟云专用idea插件

下载地址：https://itapis.cvte.com/cfile/93caaf4e-478e-4026-a87d-e68b0a9d7713/v1/download/fd07ac04d3dd4505b5324eb067cc7f00

直接拖拽到idea中即可安装

插件配置：

插件安装好后，打开设置面板：Tools -> angora -> Configure Plugin in Project，填写相关设置

填写项 说明
域帐号 您的域账号，如导入提示没有权限，请让你们项目的测试大佬帮忙加上
项目ID 在swapi平台上找到您的项目，并查看该项目ID
SWQA地址 当前保持默认即可
右键关联在线API 可选，若50ms内返回API存在信息，则判定为存在

示例图：

1. 写好接口，加好文档注释

（1）Controller类

  • 说明：

a) 只识别：@RestMapping或者@RestController 或者 @Controller + @ResponseBody

b) 只识别：@RequestMapping，当前只支持了value单个值

c) 文档注释（不包含*）：

作用点 说明
第一行描述 作为该controller下接口的分组名称
@version 对应导出后的tag
@group 自定义tag，对应导出后的api分组名称，比第一行的优先级高
（2）具体接口方法

  • 说明：

a) 支持几个常用的注解和对应的value：@GetSignMapping、@PostSignMapping、@PutSignMapping、@DeleteSignMapping、@PatchSignMapping、@GetMapping、@PutMapping、@PostMapping、@DeleteMapping

b) @Deprecated：标识该接口状态是废弃

c) 文档注释（不包含*）：

作用点 说明
第一行描述 作为这个接口的名称
其它行描述，不含@tag行 作为描述内容
@param 可通过idea自动生成，只有加了@param的参数才会被识别，如HttpServletRequest request是不会被识别的。param的描述作为该参数的描述
@deprecated 标识该接口状态是废弃，同@Deprecated
@status 指定接口状态，可选值有 NEW, PUBLISHED, DEPRECATED, IN_DEV, IN_TEST，默认是IN_DEV
@name 自定义注释标签，用于描述接口名称。若存在，则覆盖上述第一行
@apiNote java注释标签，用于描述性信息。若存在，则覆盖上述描述内容
@since java注释标签，用于版本标签。
@tag 自定义注释标签，用于版本标签。
@header 请求header参数，多个写多行，如：@header myheader 头部
@form 标识该参数是form表单格式
@map 定义类型为map的参数名，如fun(Map myMap)，可通过@map myMap.keyName[int] 参数名来指定map的参数名keyName，其中[int]指定的参数类型。
@return 返回值描述。若返回值为java.lang.Object，可通过{@link YouClass}指定返回值
（3）pojo参数


  • 说明：

a) 类注释和属性注释作为描述。如无，则描述为改类型的全限定名称。

2. 导出到swapi平台

  • 在具体API代码中单击右键，点击Export Api导入即可。

  • 如上图所示，可以自定义快捷键，Mac中默认为：shift + command + l
  • View Api On Web可以打开项目API的首页地址，在idea配置中可以查看

3. 完善接口

在swqa平台查看导入的接口，根据需要编辑接口，将其完善，以方便前端和测试的同事

登录接口测试平台

域账户访问地址：https://swqa.gz.cvte.cn/#/interfaceTest/group/cdd49b8a85f6436daa34db8fa9d1e9b5

在线调试接口

保存接口为测试用例

查看接口变更记录

作者：王浩彬  创建时间：2023-09-08 15:04
最后编辑：王浩彬  更新时间：2024-12-23 11:22