swagger文档规范

规范负责人：所有人

一、目的：为了规范swagger接口的描述、加强接口质量控制、接口跟踪、减少品控人员与研发人员对接口理解的分歧，从2019-4-1日开始执行如下规范。

二、规范要求：

swagger文档必须符合如下要求：

1、提测申请单中提交测试的接口必须在swagger中有对应的接口文档描述；

2、swagger上接口名称，状态码与实际接口调用作用/返回码保持一致；

3、swagger文档必须能正常调用对应环境的接口，在swagger上可以直接进行对应项目、对应服务接口的调用；

4、接口文档各个字段的类型、长度边界、特殊校验等必须进行说明；

5、接口测试过程中发现的以上问题及时进行记录、跟踪、推进和解决，接口测试通过的条件为swagger文档符合要求、接口无明显Bug，否则不允许上线；

6、符合总集对swagger、接口相应规范的要求，与品质管控部冲突的以总集为准。

三、管理办法

1、此规范于2019-4-1日开始执行生效，由各个城市通测试负责人与研发同步、推进和跟进。

2、过渡期完成后，如未按照规范制定实施的，测试人员对该提测内容拒绝测试，并对该过程记录到过程问题中。

3、该问题过程记录在项目结束后统计部门触发次数，并对此实施处罚。