检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
http类型接口。 设计API 接口文档应针对以下要素进行设计： 接口基本信息 接口路径 请求方式 接口请求参数 接口返回响应 安全方案 接口基本信息 填写接口的基本信息，包括： 名称：接口名称。 摘要：接口的摘要信息。 状态：API生命周期的状态，包括设计中、联调中、测试中、测试完、已发布、将废弃、已废弃。
http类型接口。 设计API 接口文档应针对以下要素进行设计： 接口基本信息 接口路径 请求方式 接口请求参数 接口返回响应 安全方案 接口基本信息 填写接口的基本信息，包括： 名称：接口名称。 摘要：接口的摘要信息。 状态：API生命周期的状态，包括设计中、联调中、测试中、测试完、已发布、将废弃、已废弃。
Markdown设计 新建Markdown，可通过以下三种方式完成。 方法一：单击目录树搜索框右侧的，在弹出的下拉框中，选择“新建Markdown”。 方法二：在目录树中选择一个目录，单击右侧图标，在弹出的下拉框中，选择“新建Markdown”。 进入“新建标签页”，在该标签页可
Markdown设计 新建Markdown，可通过以下三种方式完成。 方法一：单击“新建 Markdown”图标。 方法二：单击目录树搜索框右侧的，在弹出的下拉框中，选择“新建Markdown”。 方法三：在目录树中选择一个目录，单击右侧图标，在弹出的下拉框中，选择“新建Markdown”。
API设计 项目概况 API设计 接口审核 编辑模式与API规范检查 公共模型 Markdown设计 API调试 脚本能力
API设计 API设计 接口审核 编辑模式与API规范检查 公共模型 Markdown设计 API调试 脚本能力
Mock规则设计 配置请求规则 请求Mock服务时，系统会根据规则中配置的参数匹配，只有规则下所有参数满足匹配条件时，才可匹配到整个规则。 请求参数，支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。
Mock规则设计 配置请求规则 请求Mock服务时，系统会根据规则中配置的参数匹配，只有规则下所有参数满足匹配条件时，才可匹配到整个规则。 请求参数，支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。
n”结构。 在设计API的响应体时，可以直接引用已设计好的公共响应。 公共响应文档页面可以查看引用当前公共响应的API。 公共参数 接口的公共请求参数，参数位置可选“query”参数、“path”参数、“header”参数。 在设计API的请求参数时，可以引用已设计好的公共参数。
raw：在文本框中输入文本内容，在“raw”选项旁边可以下拉选择输入文本内容格式，如Text和Json。 请求参数的默认值均来自API设计的样例值。 在API调试页面修改请求参数，不能保存至API设计与API文档中。 返回响应 显示响应是否成功、响应时间、状态码、请求方式以及响应体信息和响应头信息。 保存为用例
n”结构。 在设计API的响应体时，可以直接引用已设计好的公共响应。 公共响应文档页面可以查看引用当前公共响应的API。 公共参数 接口的公共请求参数，参数位置可选“query”参数、“path”参数、“header”参数。 在设计API的请求参数时，可以引用已设计好的公共参数。
CodeArts API既可以帮助个人开发者一站式管理运营自己的API，摆脱工具、环境的束缚，快速实现API资产变现；也可以帮助企业规范化API流程，端到端提升设计、开发、测试、运维、运营等各组织的配合效率。 图1 CodeArts API使用场景
项目概况 进入CodeArts API目标项目后，默认进入项目概况页面，可查看项目下数据统计及API集合情况。 父主题： API设计
raw：在文本框中输入文本内容，在“raw”选项旁边可以下拉选择输入文本内容格式，如Text和Json。 请求参数的默认值均来自API设计的样例值。 在API调试页面修改请求参数，不能保存至API设计与API文档中。 返回响应 显示响应是否成功、响应时间、状态码、请求方式以及响应体信息和响应头信息。 保存为用例
CodeArts API既可以帮助个人开发者一站式管理运营自己的API，摆脱工具、环境的束缚，快速实现API资产变现；也可以帮助企业规范化API流程，端到端提升设计、开发、测试、运维、运营等各组织的配合效率。 图1 CodeArts API使用场景
接口审核 审核设置 提交审核 接口审核 父主题： API设计
审核设置 API设计审核为用户提供了一套成熟的审核流程，帮助检查项目中设计的API接口是否符合需求。 角色权限 项目经理和项目创建者有审核设置权限。 开启审核功能 单击“项目设置 > 功能设置”，进入“功能设置”页面。 在“审核设置”页签，审核设置按钮默认为关闭状态，单击，开启审核功能。
审核设置 API设计审核为用户提供了一套成熟的审核流程，帮助检查项目中设计的API接口是否符合需求。 角色权限 项目经理和项目创建者有审核设置权限。 开启审核功能 单击“项目设置 > 功能设置”，进入“功能设置”页面。 在“审核设置”页签，审核设置按钮默认为关闭状态，单击，开启审核功能。
接口审核 审核设置 提交审核 接口审核 父主题： API设计
API在API设计界面提供代码编辑模式进行API设计，可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能，可以形成统一的设计规范，避免API设计不一致，提高API设计质量。API规范设计定义，请参照设置API设计规范。 编辑模式
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
