检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
选项中的“新建API接口”,创建http类型接口。 设计API 接口文档应针对以下要素进行设计: 接口基本信息 接口路径 请求方式 接口请求参数 接口返回响应 安全方案 接口基本信息 填写接口的基本信息,包括: 名称:接口名称。 摘要:接口的摘要信息。 状态:API生命周期的状态
选项中的“新建API接口”,创建http类型接口。 设计API 接口文档应针对以下要素进行设计: 接口基本信息 接口路径 请求方式 接口请求参数 接口返回响应 安全方案 接口基本信息 填写接口的基本信息,包括: 名称:接口名称。 摘要:接口的摘要信息。 状态:API生命周期的状态
API设计 项目概况 API设计 接口审核 编辑模式与API规范检查 公共模型 Markdown设计 API调试 脚本能力
API设计 项目概况 API设计 接口审核 编辑模式与API规范检查 公共模型 Markdown设计 API调试 脚本能力
请求参数的默认值均来自API设计的样例值。 在API调试页面修改请求参数,不能保存至API设计与API文档中。 返回响应 显示响应是否成功、响应时间、状态码、请求方式以及响应体信息和响应头信息。 保存为用例 CodeArts API支持将调试结果保存为接口用例,接口用例可以记录请求参数,方便后续接口调试。
请求参数的默认值均来自API设计的样例值。 在API调试页面修改请求参数,不能保存至API设计与API文档中。 返回响应 显示响应是否成功、响应时间、状态码、请求方式以及响应体信息和响应头信息。 保存为用例 CodeArts API支持将调试结果保存为接口用例,接口用例可以记录请求参数,方便后续接口调试。
n文件的目录也会同步改变。 Markdown文件只能在同一根目录下进行移动。 处于编辑页面的Markdown文件不能移动。 父主题: API设计
n文件的目录也会同步改变。 Markdown文件只能在同一根目录下进行移动。 处于编辑页面的Markdown文件不能移动。 父主题: API设计
种类型选择,选择不同类型的安全模型后,需要在方案内容中完善相关必填信息,用于API设计中“安全方案”的引用。在安全模型的文档页可以查看引用当前安全模型的API。 公共响应头 接口的公共响应头,在API设计中“返回响应”中响应头可进行公共响应头的引用。在公共响应头的文档页可以查看引用当前公共响应头的API。
种类型选择,选择不同类型的安全模型后,需要在方案内容中完善相关必填信息,用于API设计中“安全方案”的引用。在安全模型的文档页可以查看引用当前安全模型的API。 公共响应头 接口的公共响应头,在API设计中“返回响应”中响应头可进行公共响应头的引用。在公共响应头的文档页可以查看引用当前公共响应头的API。
编辑模式与API规范检查 CodeArts API在API设计界面提供代码编辑模式进行API设计,可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能,可以形成统一的设计规范,避免API设计不一致,提高API设计质量。AP
编辑模式与API规范检查 CodeArts API在API设计界面提供代码编辑模式进行API设计,可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能,可以形成统一的设计规范,避免API设计不一致,提高API设计质量。AP
pm对象API参考 pm pm:Object pm对象,含有接口运行关联信息。可利用它获取或设置环境变量和全局变量,且访问请求信息和返回结果信息。 pm:info:Object pm.info对象,含有接口运行关联信息。 pm.info.eventName:String:获取当前
项目概况 进入CodeArts API目标项目后,默认进入项目概况页面,可查看项目下数据统计及API集合情况。 父主题: API设计
项目概况 进入CodeArts API目标项目后,默认进入项目概况页面,可查看项目下数据统计及API集合情况。 父主题: API设计
pm对象API参考 pm pm:Object pm对象,含有接口运行关联信息。可利用它获取或设置环境变量和全局变量,且访问请求信息和返回结果信息。 pm:info:Object pm.info对象,含有接口运行关联信息。 pm.info.eventName:String:获取当前
接口审核 审核设置 提交审核 接口审核 父主题: API设计
接口审核 审核设置 提交审核 接口审核 父主题: API设计
Mock规则设计 配置请求规则 请求Mock服务时,系统会根据规则中配置的参数匹配,只有规则下所有参数满足匹配条件时,才可匹配到整个规则。 请求参数,支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。
Mock规则设计 配置请求规则 请求Mock服务时,系统会根据规则中配置的参数匹配,只有规则下所有参数满足匹配条件时,才可匹配到整个规则。 请求参数,支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。