文档首页/ CodeArts API/ 快速入门
更新时间:2024-09-14 GMT+08:00
分享

快速入门

使用CodeArts API快速设计并调试接口

访问CodeArts API产品首页,单击“网页版体验”,首次使用华为云账号登录CodeArts 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规则。

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

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

新建快捷调试

  1. 单击“快捷调试”模块,进入快捷调试首页,可通过以下两种入口新建快捷调试。
    • 入口一:单击主页面的“新建快捷调试”图标。
    • 入口二:单击搜索框旁,选择“新建快捷调试”选项。

  2. 进入快捷调试”页面,输入接口完整URL,单击“发送”即可对已有接口进行快捷调试,也可保存为接口。

    • Params、Header、Cookies、Auth参数设计请参照API设计进行快速设计。
    • 前置脚本、后置脚本操作请查看脚本能力章节。

相关文档