检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
选项中的“新建API接口”，创建http类型接口。 设计API 接口文档应针对以下要素进行设计： 接口基本信息 接口路径 请求方式 接口请求参数 接口返回响应 安全方案 接口基本信息 填写接口的基本信息，包括： 名称：接口名称。 摘要：接口的摘要信息。 状态：API生命周期的状态
API设计 项目概况 API设计 接口审核 编辑模式与API规范检查 公共模型 Markdown设计 API调试 脚本能力
单击，弹出“接口审核”页面，默认可查看项目中所有“待审核”状态的API接口列表。 单击操作列的，弹出“审核详情”页面，可查看API接口变更前后的对比详情。 填写“审核意见”，单击“通过”或“拒绝”，完成API接口的审核。 对于已提交审核的API接口，提交人员可通过进入“接口审核”页面进行撤回审核的操作。
接口审核 审核设置 提交审核 接口审核 父主题： API设计
选项中的“新建API接口”，创建http类型接口。 设计API 接口文档应针对以下要素进行设计： 接口基本信息 接口路径 请求方式 接口请求参数 接口返回响应 安全方案 接口基本信息 填写接口的基本信息，包括： 名称：接口名称。 摘要：接口的摘要信息。 状态：API生命周期的状态
单击，弹出“接口审核”页面，默认可查看项目中所有“待审核”状态的API接口列表。 单击操作列的，弹出“审核详情”页面，可查看API接口变更前后的对比详情。 填写“审核意见”，单击“通过”或“拒绝”，完成API接口的审核。 对于已提交审核的API接口，提交人员可通过进入“接口审核”页面进行撤回审核的操作。
接口审核 审核设置 提交审核 接口审核 父主题： API设计
API设计 项目概况 API设计 接口审核 编辑模式与API规范检查 公共模型 Markdown设计 API调试 脚本能力
请求参数的默认值均来自API设计的样例值。 在API调试页面修改请求参数，不能保存至API设计与API文档中。 返回响应 显示响应是否成功、响应时间、状态码、请求方式以及响应体信息和响应头信息。 保存为用例 CodeArts API支持将调试结果保存为接口用例，接口用例可以记录请求参数，方便后续接口调试。
pm对象API参考 pm pm:Object pm对象，含有接口运行关联信息。可利用它获取或设置环境变量和全局变量，且访问请求信息和返回结果信息。 pm:info:Object pm.info对象，含有接口运行关联信息。 pm.info.eventName:String：获取当前
审核功能开启后，对于API接口的操作都需要提交审核并通过后才可生效。 查看接口变更对比 当进行新增、修改、删除API接口的操作后，接口列表会出现相应提示图标。 单击变更的API接口，在API“文档”页面单击“变更对比”。 弹出“变更对比”页面，可查看API接口变更前后的对比详情。
开启审核功能后，在项目下API设计中创建、删除、修改API的操作均会被记录为草稿内容，需要通过审核后生效。 关闭审核功能 在“审核设置”页签，单击，弹出“审核设置”对话框。 根据提示输入“CLOSE”后，单击“确定”，关闭审核功能。 关闭审核功能后，在项目下API设计中创建、删除、修改API的操作
编辑模式与API规范检查 CodeArts API在API设计界面提供代码编辑模式进行API设计，可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能，可以形成统一的设计规范，避免API设计不一致，提高API设计质量。AP
请求参数的默认值均来自API设计的样例值。 在API调试页面修改请求参数，不能保存至API设计与API文档中。 返回响应 显示响应是否成功、响应时间、状态码、请求方式以及响应体信息和响应头信息。 保存为用例 CodeArts API支持将调试结果保存为接口用例，接口用例可以记录请求参数，方便后续接口调试。
编辑模式与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：获取当前
n文件的目录也会同步改变。 Markdown文件只能在同一根目录下进行移动。 处于编辑页面的Markdown文件不能移动。 父主题： API设计
开启审核功能后，在项目下API设计中创建、删除、修改API的操作均会被记录为草稿内容，需要通过审核后生效。 关闭审核功能 在“审核设置”页签，单击，弹出“审核设置”对话框。 根据提示输入“CLOSE”后，单击“确定”，关闭审核功能。 关闭审核功能后，在项目下API设计中创建、删除、修改API的操作
审核功能开启后，对于API接口的操作都需要提交审核并通过后才可生效。 约束与限制 审核流程结束前，提交审核的API接口将处于锁定状态，不可编辑和删除。 查看接口变更对比 当进行新增、修改、删除API接口的操作后，接口列表会出现相应提示图标。 单击变更的API接口，在API“文档”页面单击“变更对比”。
移动Markdown（可选）。 单击并拖拽Markdown到目标目录后释放即可，移动成功后，目录树会自动刷新，Markdown文件的目录也会同步改变。 父主题： API设计
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
