OpenAPI Explorer官方提供的Mock场景和示例是有限的,没有覆盖全部的产品,也不能完全覆盖用户遇到的问题。我们提供了贡献Mock的功能,让用户可以一起来提交Mock示例。共同完善Mock场景。

背景信息

贡献Mock的操作步骤

操作步骤

  1. 打开OpenAPI Explorer,你想要提交Mock示例的API的数据模拟标签页。
  2. 点击进入贡献Mock页面,填写表单,创建后,提交审核。
    • tag:是Mock示例的唯一标识,应该填写当前示例的英文描述短语或错误关键字,也可以使用error code。如:ForbiddenUnauthorized、EmptyData。
    • 名称:是Mock示例中文名称,应该填写Mock示例的中文名称,名称会显示在数据模拟标签页作为title使用。如:禁止无权限、空数据。
    • response:是Mock示例的返回值,要求填写真实返回数据,并且是json格式。如:
      {
          "ProductInfos": {
              "ProductInfo": [  
                  {
                      "Description": "Bulbs in the rooms",
                      "ProductKey": "a1h7knJdld1",
                      "NodeType": 0,
                      "CreateTime": 1545355537000,
                      "ProductB": "Bulbs"
                  }
              ]
          },
          "RequestId": "2E410BE3-C688-487B-9BF1-F04B33632CCC",
          "Success": true
      }
  3. 提交Mock示例后,会有相关人员审核Mock示例是否适合,如果没问题,会直接通过,然后展示在API页面,数据模拟的示例中。如果有一些不合适的地方,审核人员和提出修改的建议。

    如果审核通过,会展示在API页面的数据模拟标签页中。

    如果没有通过审核,则需要根据修改建议,修改mock示例。修改完成,再次提交审核。