检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API调试 完成API设计之后,在API文档页面单击“运行”会自动切换到API调试页面,也可以单击“调试”页签切换到API调试页面,本节介绍调试页面相关信息配置。 由于浏览器限制,使用CodeArts API的Web版本进行接口调试,需要先安装浏览器扩展,浏览器扩展请查看浏览器扩展。
API调试 完成API设计之后,在API文档页面单击“运行”会自动切换到API调试页面,也可以单击“调试”页签切换到API调试页面,本节介绍调试页面相关信息配置。 由于浏览器限制,使用CodeArts API的Web版本进行接口调试,需要先安装浏览器扩展,浏览器扩展请查看浏览器扩展。
查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情。 其他项目参与者有权限同步查看项目下任意API接口的变更详情。 提交审核
查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情。 其他项目参与者有权限同步查看项目下任意API接口的变更详情。 提交审核
mockjs:模拟数据生成,拦截Ajax请求。 csv-parse/lib/sync( v1.2.4):处理CSV格式数据。 iconv-lite:用于字符编码转换,支持数十种字符编码格式的转换。 内置NodeJS模块 path:处理文件路径。 assert:提供一组断言测试。 buffer:处理二进制数据。 util:实用函数的集合。
mockjs:模拟数据生成,拦截Ajax请求。 csv-parse/lib/sync( v1.2.4):处理CSV格式数据。 iconv-lite:用于字符编码转换,支持数十种字符编码格式的转换。 内置NodeJS模块 path:处理文件路径。 assert:提供一组断言测试。 buffer:处理二进制数据。 util:实用函数的集合。
行快速切换,也可对不同版本API接口进行直接对比。 创建版本 单击项目名称,进入目标项目,单击“项目设置 > 版本管理”,进入“版本管理”页面。 单击“新增版本”,填写版本号和描述,默认勾选“同步创建测试版本”。 单击“确定”。 单击项目名称下“基线”旁的下拉框,可快速切换版本(
行快速切换,也可对不同版本API接口进行直接对比。 创建版本 单击项目名称,进入目标项目,单击“项目设置 > 版本管理”,进入“版本管理”页面。 单击“新增版本”,填写版本号和描述,默认勾选“同步创建测试版本”。 单击“确定”。 单击项目名称下“基线”旁的下拉框,可快速切换版本(
操作步骤 单击,弹出“接口审核”页面,默认可查看项目中所有“待审核”状态的API接口列表。 单击操作列的,弹出“审核详情”页面,可查看API接口变更前后的对比详情。 填写“审核意见”,单击“通过”或“拒绝”,完成API接口的审核。 对于已提交审核的API接口,提交人员可通过进入“接口审核”页面进行撤回审核的操作。
操作步骤 单击,弹出“接口审核”页面,默认可查看项目中所有“待审核”状态的API接口列表。 单击操作列的,弹出“审核详情”页面,可查看API接口变更前后的对比详情。 填写“审核意见”,单击“通过”或“拒绝”,完成API接口的审核。 对于已提交审核的API接口,提交人员可通过进入“接口审核”页面进行撤回审核的操作。
接口参数值,为了方便快速切换运行环境,快速修改前置URL等参数,CodeArts API提供了环境管理功能。 前提条件 免费开通“API测试”的高阶功能试用或开通CodeArts TestPlan套餐。 环境参数入口 进入目标项目后,在右上角提供快速切换环境下拉框,提供快速搜索功能。
接口参数值,为了方便快速切换运行环境,快速修改前置URL等参数,CodeArts API提供了环境管理功能。 前提条件 免费开通“API测试”的高阶功能试用或开通CodeArts TestPlan套餐。 环境参数入口 进入目标项目后,在右上角提供快速切换环境下拉框,提供快速搜索功能。
API文档页面展示了定义好的API信息,包括API路径、请求参数、请求体、返回响应等信息,可通过右侧文档目录切换至对应模块进行查看。在文档展示页面,可以修改API状态。单击“运行”,可切换到调试页面进行API调试。 父主题: API设计
API文档页面展示了定义好的API信息,包括API路径、请求参数、请求体、返回响应等信息,可通过右侧文档目录切换至对应模块进行查看。在文档展示页面,可以修改API状态。单击“运行”,可切换到调试页面进行API调试。 父主题: API设计
进入项目后,单击搜索框旁,可根据需要选择“新建快捷调试”进行新建快捷调试操作。 导入与导出功能需要登录后才可以继续使用。 前置脚本、后置脚本功能需要登录后才可继续使用。 切换登录状态 单击以下功能菜单可弹出登录页面,进行登录后可体验产品的全部功能。 父主题: 客户端访问
进入项目后,单击搜索框旁,可根据需要选择“新建快捷调试”进行新建快捷调试操作。 导入与导出功能需要登录后才可以继续使用。 前置脚本、后置脚本功能需要登录后才可继续使用。 切换登录状态 单击以下功能菜单可弹出登录页面,进行登录后可体验产品的全部功能。 父主题: 客户端访问
使用API设计 示例项目中已经预设了不同请求的API示例和公共模型。单击任意接口,如“查询产品列表”。 默认进入“文档”页签,可通过右侧文档目录切换页面。 单击“设计”页签可以进入API设计页面,详细操作可参照API设计章节。 单击“调试”页签进入调试页面,详细操作可参照示例接口调试。
预设了不同请求的API示例和公共模型。 在“API设计”模块,单击任意接口,如“查询产品列表”。 默认进入“文档”页签,可通过右侧文档目录切换页面。 单击“设计”页签可以进入API设计页面,操作可参照API设计章节。 单击“调试”页签进入调试页面,操作可参照示例接口调试。 示例接口调试
对参数的简要描述,上限为3000字符。默认为当前参数类型的描述。 单击“文本框”后,用户可以直接输入文本描述。 单击,输入一个json,单击“Json转换”,可以给没有换行的Json添加换行和缩进,单击“回填”添加成功。 值 否 用户可以为不同类型的参数赋值。 敏感变量 否 勾选为敏感数据后
对参数的简要描述,上限为3000字符。默认为当前参数类型的描述。 单击“文本框”后,用户可以直接输入文本描述。 单击,输入一个json,单击“Json转换”,可以给没有换行的Json添加换行和缩进,单击“回填”添加成功。 值 否 用户可以为不同类型的参数赋值。 敏感变量 否 勾选为敏感数据后