API调试

接口路径

API调试页面的接口路径，可以选择http或https，并在定义的路径前自动添加了域名。添加的域名是在右上角选择的环境参数中定义的，单击左侧下拉箭头可在不同运行环境间切换，单击下拉箭头右上角按钮，可进行环境参数配置。

针对各个环境，默认提供变量“hostURL”参数作为添加到接口前的域名，从而拼接成完整地址。

可以看到对应环境“默认环境”中的“hostURL”参数的值“127.0.0.1:8080”被添加到接口URL前，作为整个路径的域名。鼠标悬浮在路径前，提示此前置URL来自于哪一环境，单击环境名称，可直接跳转至相应环境下进行编辑。

• 路径中大括号“{}”中的字符串表示Path参数。
• 路径中“?”后的字符串表示Query参数。
• 如果在调试页面路径栏下方的Query属性框中，对Query参数进行修改，路径中的Query参数也会同步变化。

Mock选项

打开URL输入框右侧的MockURL按钮，开启Mock服务，接口路径的域名会变成云端Mock地址。Mock服务具体功能请请参考API Mock。

请求参数

• Query参数：在Params页签查看，默认填充了接口定义好了的Query参数，名称可修改。
• Path参数：在Params页签查看，默认填充了接口定义好了的Path参数，名称不可修改。
• Header参数：默认填充了接口定义好了的Query参数，名称可修改。

请求体

在Body页签中，可以查看请求体，目前支持的请求体有如下几类：

• none：无body参数。
• form-data：Content-Type为“multipart/form-data”，可以输入请求体中每个参数的类型、名称和值。
• application/x-www-form-urlencoded：Content-Type为“application/x-www-form-urlencoded”，可以输入请求体中每个参数的名称和值。
• raw：在文本框中输入文本内容，在“raw”选项旁边可以下拉选择输入文本内容格式，如Text和Json。

• 请求参数的默认值均来自API设计的样例值。
• 在API调试页面修改请求参数，不能保存至API设计与API文档中。

返回响应

显示响应是否成功、响应时间、状态码、请求方式以及响应体信息和响应头信息。

保存为用例

CodeArts API支持将调试结果保存为接口用例，接口用例可以记录请求参数，方便后续接口调试。

1. 单击发送后，在返回响应中调试成功后，单击“保存为用例”，弹出“用例”弹窗，自定义用例名称或选择系统预设名称。

   

2. 单击“确定”。

3. 右上角提示“保存成功”后，在左侧目标API下可查看到已保存的用例。