检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
状态：API生命周期的状态，包括设计中、联调中、测试中、测试完、已发布、将废弃、已废弃。 所属目录：接口在项目中所属的目录。 所属Tags：接口所属的Tags，可以直接选择所属目录信息当作所属Tags，也可以在所属Tags框中手动输入Tag名再回车来生成所属Tags。 描述：可添加接口的相关描述，包括接口
Markdown设计 新建Markdown，可通过以下三种方式完成。 方法一：单击目录树搜索框右侧的，在弹出的下拉框中，选择“新建Markdown”。 方法二：在目录树中选择一个目录，单击右侧图标，在弹出的下拉框中，选择“新建Markdown”。 进入“新建标签页”，在该标签页可
表达式（选择表达式后输入“@”符开启选择）。 存在、不存在：判断Query、Header名称是否存在。 包含、不包含：判断Query、Header、Path中的某个字段的值是否包含某个值。 正则：判断Query、Header、Path中的某个字段的值是否符合正则表达式中的匹配规则。 区间范围
状态：API生命周期的状态，包括设计中、联调中、测试中、测试完、已发布、将废弃、已废弃。 所属目录：接口在项目中所属的目录。 所属Tags：接口所属的Tags，可以直接选择所属目录信息当作所属Tags，也可以在所属Tags框中手动输入Tag名再回车来生成所属Tags。 描述：可添加接口的相关描述，包括接口
API设计 项目概况 API设计 接口审核 编辑模式与API规范检查 公共模型 Markdown设计 API调试 脚本能力
Markdown设计 约束与限制 Markdown文件只能在同一根目录下进行移动。 处于编辑页面的Markdown文件不能移动。 创建Markdown文件 新建Markdown，可通过以下三种方式完成。 方法一：单击目录树搜索框右侧的，在弹出的下拉框中，选择“新建Markdown”。
表达式（选择表达式后输入“@”符开启选择）。 存在、不存在：判断Query、Header名称是否存在。 包含、不包含：判断Query、Header、Path中的某个字段的值是否包含某个值。 正则：判断Query、Header、Path中的某个字段的值是否符合正则表达式中的匹配规则。 区间范围
API设计 项目概况 API设计 接口审核 编辑模式与API规范检查 公共模型 Markdown设计 API调试 脚本能力
开启审核功能后，在项目下API设计中创建、删除、修改API的操作均会被记录为草稿内容，需要通过审核后生效。 关闭审核功能 在“审核设置”页签，单击，弹出“审核设置”对话框。 根据提示输入“CLOSE”后，单击“确定”，关闭审核功能。 关闭审核功能后，在项目下API设计中创建、删除、修改API的操作将立
项目概况 进入CodeArts API目标项目后，默认进入项目概况页面，可查看项目下数据统计及API集合情况。 父主题： API设计
数据模型和编程语言里的数据结构概念类似，主要用于接口设计场景中的“返回响应”和json/xml类型的“Body参数”。 在设计API的Body体或响应体时，可以直接引用公共数据结构。 数据结构被引用后，可以在数据结构的文档页面查看引用当前数据结构的API和模型。 公共响应 接口的公共响应返
开启审核功能后，在项目下API设计中创建、删除、修改API的操作均会被记录为草稿内容，需要通过审核后生效。 关闭审核功能 在“审核设置”页签，单击，弹出“审核设置”对话框。 根据提示输入“CLOSE”后，单击“确定”，关闭审核功能。 关闭审核功能后，在项目下API设计中创建、删除、修改API的操作将立
API在API设计界面提供代码编辑模式进行API设计，可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能，可以形成统一的设计规范，避免API设计不一致，提高API设计质量。API规范设计定义，请参照设置API设计规范。 编辑模式
API在API设计界面提供代码编辑模式进行API设计，可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能，可以形成统一的设计规范，避免API设计不一致，提高API设计质量。API规范设计定义，请参照设置API设计规范。 编辑模式
数据模型和编程语言里的数据结构概念类似，主要用于接口设计场景中的“返回响应”和json/xml类型的“Body参数”。 在设计API的Body体或响应体时，可以直接引用公共数据结构。 数据结构被引用后，可以在数据结构的文档页面查看引用当前数据结构的API和模型。 公共响应 接口的公共响应返
项目概况 进入CodeArts API目标项目后，默认进入项目概况页面，可查看项目下数据统计及API集合情况。 父主题： API设计
可以看到对应环境“默认环境”中的“hostURL”参数的值“127.0.0.1:8080”被添加到接口URL前，作为整个路径的域名。鼠标悬浮在路径前，提示此前置URL来自于哪一环境，单击环境名称，可直接跳转至相应环境下进行编辑。 路径中大括号“{}”中的字符串表示Path参数。 路径中“?”后的字符串表示Query参数。
可以看到对应环境“默认环境”中的“hostURL”参数的值“127.0.0.1:8080”被添加到接口URL前，作为整个路径的域名。鼠标悬浮在路径前，提示此前置URL来自于哪一环境，单击环境名称，可直接跳转至相应环境下进行编辑。 路径中大括号“{}”中的字符串表示Path参数。 路径中“?”后的字符串表示Query参数。
接口审核 审核设置 提交审核 接口审核 父主题： API设计
接口审核 审核设置 提交审核 接口审核 父主题： API设计
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
