检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
单击“确定”，进入“设计规范”页面，打开规则后的“是否启用”按钮，可启用当前规则。 完成创建API设计规范后，单击“启用”，可正式使用设计规范。 无需检查接口 支持添加无需检查接口。 在“无需检查的接口”页签，单击“添加API接口”，弹出“添加不需要检查的接口”对话框。 选择无需检查接口，单击“确定”，完成添加。
选项中的“新建API接口”，创建http类型接口。 设计API 接口文档应针对以下要素进行设计： 接口基本信息 接口路径 请求方式 接口请求参数 接口返回响应 安全方案 接口基本信息 填写接口的基本信息，包括： 名称：接口名称。 摘要：接口的摘要信息。 状态：API生命周期的状态
API设计 项目概况 API设计 接口审核 编辑模式与API规范检查 公共模型 Markdown设计 API调试 脚本能力
单击“确定”，进入“设计规范”页面，打开规则后的“是否启用”按钮，可启用当前规则。 完成创建API设计规范后，单击“启用”，可正式使用设计规范。 无需检查接口 支持添加无需检查接口。 在“无需检查的接口”页签，单击“添加API接口”，弹出“添加不需要检查的接口”对话框。 选择无需检查接口，单击“确定”，完成添加。
API开发 CodeArts API支持生成接口请求代码和业务代码，缩短前后端开发时长，规范代码结构。 基于接口定义，CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块，接口文档界面右侧，即可看到“生成代码”的入口。 生成接口请求代码 单击“
单击，弹出“接口审核”页面，默认可查看项目中所有“待审核”状态的API接口列表。 单击操作列的，弹出“审核详情”页面，可查看API接口变更前后的对比详情。 填写“审核意见”，单击“通过”或“拒绝”，完成API接口的审核。 对于已提交审核的API接口，提交人员可通过进入“接口审核”页面进行撤回审核的操作。
接口审核 审核设置 提交审核 接口审核 父主题： API设计
选项中的“新建API接口”，创建http类型接口。 设计API 接口文档应针对以下要素进行设计： 接口基本信息 接口路径 请求方式 接口请求参数 接口返回响应 安全方案 接口基本信息 填写接口的基本信息，包括： 名称：接口名称。 摘要：接口的摘要信息。 状态：API生命周期的状态
API设计 项目概况 API设计 接口审核 编辑模式与API规范检查 公共模型 Markdown设计 API调试 脚本能力
API调试 完成API设计之后，在API文档页面单击“运行”会自动切换到API调试页面，也可以单击“调试”页签切换到API调试页面，本节介绍调试页面相关信息配置。 由于浏览器限制，使用CodeArts API的Web版本进行接口调试，需要先安装浏览器扩展，浏览器扩展请查看浏览器扩展。
API开发 CodeArts API支持生成接口请求代码和业务代码，缩短前后端开发时长，规范代码结构。 基于接口定义，CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块，接口文档界面右侧，即可看到“生成代码”的入口。 生成接口请求代码 单击“
单击，弹出“接口审核”页面，默认可查看项目中所有“待审核”状态的API接口列表。 单击操作列的，弹出“审核详情”页面，可查看API接口变更前后的对比详情。 填写“审核意见”，单击“通过”或“拒绝”，完成API接口的审核。 对于已提交审核的API接口，提交人员可通过进入“接口审核”页面进行撤回审核的操作。
接口审核 审核设置 提交审核 接口审核 父主题： API设计
pm对象API参考 pm pm:Object pm对象，含有接口运行关联信息。可利用它获取或设置环境变量和全局变量，且访问请求信息和返回结果信息。 pm:info:Object pm.info对象，含有接口运行关联信息。 pm.info.eventName:String：获取当前
一致，所写即所得，以使用者视角定义API。 API设计规范检查 基于华为10年API治理经验，嵌入国内唯一“先进级”评级的API全生命周期管理规范。 支持API规范自动检查、自动纠错，提升API设计质量。 自动化代码和用例生成 API SDK代码和服务框架代码与API设计同源，基于API文档一键生成代码。
API调试 完成API设计之后，在API文档页面单击“运行”会自动切换到API调试页面，也可以单击“调试”页签切换到API调试页面，本节介绍调试页面相关信息配置。 由于浏览器限制，使用CodeArts API的Web版本进行接口调试，需要先安装浏览器扩展，浏览器扩展请查看浏览器扩展。
pm对象API参考 pm pm:Object pm对象，含有接口运行关联信息。可利用它获取或设置环境变量和全局变量，且访问请求信息和返回结果信息。 pm:info:Object pm.info对象，含有接口运行关联信息。 pm.info.eventName:String：获取当前
API发布 API网关注册
一致，所写即所得，以使用者视角定义API。 API设计规范检查 基于华为10年API治理经验，嵌入国内唯一“先进级”评级的API全生命周期管理规范。 支持API规范自动检查、自动纠错，提升API设计质量。 自动化代码和用例生成 API SDK代码和服务框架代码与API设计同源，基于API文档一键生成代码。
CodeArts API 带您了解CodeArts API 02:34 介绍CodeArts API 操作指导 CodeArts API 介绍如何创建API设计及两种设计编辑模式 03:20 创建API设计 CodeArts API 介绍如何设置API设计规范 01:33 API规范性检查
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
