快速入门

登录CodeArts API

使用华为云账号登录CodeArts API，系统默认为新用户新建“示例项目”并进入项目，用户可基于“示例项目”进行快捷调试。

新建快捷调试

进入项目后，单击搜索框旁，可根据需要选择“新建快捷调试”或“导入Postman文件”进行快捷调试。

• 新建快捷调试
  1. 单击“新建快捷调试”，生成“快捷调试”页签。
  2. 输入接口完整URL，单击“发送”即可对已有接口进行快捷调试。

     

     • Params、Header、Cookies、Auth参数设计请参照API设计进行快速设计。
     • 前置脚本、后置脚本操作请查看脚本能力章节。
• 导入Postman文件
  1. 单击“导入Postman文件”，弹出“导入Postman文件”对话框。
  2. 上传需要导入的Postman文件，选择导入范围，可选择“全部”或者“选择快捷调试”。

     

     

     导入通过Postman导出的文件时，接口示例会被同时导入为快捷调试接口，名称和Postman中接口示例名称相同。

  3. 单击“导入”，导入成功后可直接单击“发送”进行调试，也可保存为接口。

     

使用API设计

• 单击“API设计”模块，可以看到示例项目中已经预设了不同请求的API示例和公共模型。

  

• 在“API设计”模块，单击任意接口，如“查询产品列表”。

  

  1. 默认进入“文档”页签，可通过右侧文档目录切换页面。
  2. 单击“设计”页签可以进入API设计页面，操作可参照API设计章节。
  3. 单击“调试”页签进入调试页面，操作可参照示例接口调试。

示例接口调试

1. 打开“MockURL”开关。
2. 确认云端MockURL，详细Mock规则查询请参照高级Mock。
3. 单击“发送”。
4. 在响应体中选择美化体查看响应。

   

高级Mock

CodeArts API提供高级Mock功能，可以查询和定义调试接口的Mock规则。

1. 单击接口的“高级Mock”页签，可以查看该接口对应的Mock规则。

   

2. 单击“查询产品列表”，弹出“编辑Mock规则”页面。

   可以查看Mock规则的请求参数和返回响应，可根据需要进行编辑。