美文网首页
swagger文档规范

swagger文档规范

作者: 水漾涟漪penny | 来源:发表于2021-01-25 10:21 被阅读0次

规范负责人:所有人

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

二、规范要求:

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

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

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

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

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

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

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

三、管理办法

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

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

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

相关文章

  • Spring和Swagger文档规范整合详解

    Spring和Swagger文档规范整合详解 一、概述 Swagger 是一个规范和完整的框架,用于生成、描述、调...

  • swagger文档规范

    规范负责人:所有人 一、目的:为了规范swagger接口的描述、加强接口质量控制、接口跟踪、减少品控人员与研发人员...

  • 一步步学习java后台(六)(OpenApi-Swagger的使

    OpenApi(Swagger) OpenApi,以前称为Swagger ,是最受欢迎的API文档规范之一。它允许...

  • 手动拼接一个swagger

    swagger是一个文档,openapi是一个规范,一般是根据openapi的规范,生成swagger实体类,即a...

  • SpringBoot入门建站全系列(十六)整合Swagger文档

    SpringBoot入门建站全系列(十六)整合Swagger文档中心 一、概述 Swagger 是一个规范和完整的...

  • Swagger的学习总结

    Swagger:REST APIs文档生成工具。Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视...

  • API 书写规范

    Swagger API �编写规范 参考文档地址 https://blog.mwaysolutions.com/2...

  • Swagger

    1.简介 Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件 Swagger 是一个规范...

  • API管理平台设想

    Swagger 体系 ​ 首先有人定义了一个API文档产生的规范,前期叫Swagger,后面贡献给了Linux...

  • swagger使用

    swagger介绍 swagger是一个文档生成的框架,可以通过简单的json或者yaml语言生成规范、美观的后端...

网友评论

      本文标题:swagger文档规范

      本文链接:https://www.haomeiwen.com/subject/uuebzktx.html