检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
接口审核 审核设置 提交审核 接口审核 父主题： API设计
审核设置 API设计审核为用户提供了一套成熟的审核流程，帮助检查项目中设计的API接口是否符合需求。 角色权限 项目经理和项目创建者有审核设置权限。 开启审核功能 单击“项目设置 > 功能设置”，进入“功能设置”页面。 在“审核设置”页签，审核设置按钮默认为关闭状态，单击，开启审核功能。
审核设置 API设计审核为用户提供了一套成熟的审核流程，帮助检查项目中设计的API接口是否符合需求。 角色权限 项目经理和项目创建者有审核设置权限。 开启审核功能 单击“项目设置 > 功能设置”，进入“功能设置”页面。 在“审核设置”页签，审核设置按钮默认为关闭状态，单击，开启审核功能。
API在API设计界面提供代码编辑模式进行API设计，可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能，可以形成统一的设计规范，避免API设计不一致，提高API设计质量。API规范设计定义，请参照设置API设计规范。 编辑模式
接口审核 角色权限 API审核操作用户角色类型及操作权限说明如下： 项目角色 操作 数据范围 项目创建者 查看 所有数据 审核 所有数据 撤回 自己提交的数据 项目经理 查看 所有数据 审核 所有数据 撤回 自己提交的数据 开发人员 查看 所有数据 撤回 自己提交的数据 操作步骤
接口审核 角色权限 API审核操作用户角色类型及操作权限说明如下： 项目角色 操作 数据范围 项目创建者 查看 所有数据 审核 所有数据 撤回 自己提交的数据 项目经理 查看 所有数据 审核 所有数据 撤回 自己提交的数据 开发人员 查看 所有数据 撤回 自己提交的数据 操作步骤
后置脚本 后置脚本是在请求发送后执行的代码片段，主要用于验证请求返回的结果（断言）、将请求返回的结果数据写入环境变量等场景。可以在接口的“后置脚本”页面中单击“添加后置操作”，发送接口请求后将自动运行后置脚本。 断言 可以利用后置脚本验证API响应返回结果的正确性。 // 示例1：pm
执行流程 CodeArts API提供基于JavaScript的脚本引入，通过脚本可以实现在快捷调试或接口请求时添加动态行为。脚本执行流程如图： CodeArts API兼容Postman脚本语法，可以将Postman脚本迁移到CodeArts API中使用。 CodeArts
提交审核 审核功能开启后，对于API接口的操作都需要提交审核并通过后才可生效。 查看接口变更对比 当进行新增、修改、删除API接口的操作后，接口列表会出现相应提示图标。 单击变更的API接口，在API“文档”页面单击“变更对比”。 弹出“变更对比”页面，可查看API接口变更前后的对比详情。
提交审核 审核功能开启后，对于API接口的操作都需要提交审核并通过后才可生效。 约束与限制 审核流程结束前，提交审核的API接口将处于锁定状态，不可编辑和删除。 查看接口变更对比 当进行新增、修改、删除API接口的操作后，接口列表会出现相应提示图标。 单击变更的API接口，在API“文档”页面单击“变更对比”。
的测试总数。 pm.expect pm.expect(assertion:*):Function：一个普通的断言方法，详细的说明请参照ChaiJS expect BDD library。该方法对于处理来自响应response或变量variables的数据断言非常有用，更多关于pm
前置脚本 前置脚本是在请求发送前执行的代码片段。例如需要在请求头中生成时间戳、打印日志、设置随机参数值等。可以在接口的“前置脚本”页面中单击“添加前置操作 > 自定义脚本”，发送接口请求前将自动运行前置脚本。 打印日志 可以通过“console.log()”将需要的变量打印在控制台，用以查看某个变量的当前值。
前置脚本 前置脚本是在请求发送前执行的代码片段。例如需要在请求头中生成时间戳、打印日志、设置随机参数值等。可以在接口的“前置脚本”页面中单击“添加前置操作 > 自定义脚本”，发送接口请求前将自动运行前置脚本。 打印日志 可以通过“console.log()”将需要的变量打印在控制台，用以查看某个变量的当前值。
后置脚本 后置脚本是在请求发送后执行的代码片段，主要用于验证请求返回的结果（断言）、将请求返回的结果数据写入环境变量等场景。可以在接口的“后置脚本”页面中单击“添加后置操作”，发送接口请求后将自动运行后置脚本。 断言 可以利用后置脚本验证API响应返回结果的正确性。 // 示例1：pm
执行流程 CodeArts API提供基于JavaScript的脚本引入，通过脚本可以实现在快捷调试或接口请求时添加动态行为。脚本执行流程如图： CodeArts API兼容Postman脚本语法，可以将Postman脚本迁移到CodeArts API中使用。 CodeArts
的测试总数。 pm.expect pm.expect(assertion:*):Function：一个普通的断言方法，详细的说明请参照ChaiJS expect BDD library。该方法对于处理来自响应response或变量variables的数据断言非常有用，更多关于pm
架构师在Swagger中设计API文档后，后端工程师需要根据设计文档实现代码，如果设计修改则需要手工实现代码同步。 后端工程师在API调试时，需要将设计文件导入Postman，如果设计修改则需要重复导入过程。 前端工程师需要根据设计文档在Mockjs中定义Mock返回数据，如果设计修改则需要手工修改Mock数据。
架构师在Swagger中设计API文档后，后端工程师需要根据设计文档实现代码，如果设计修改则需要手工实现代码同步。 后端工程师在API调试时，需要将设计文件导入Postman，如果设计修改则需要重复导入过程。 前端工程师需要根据设计文档在Mockjs中定义Mock返回数据，如果设计修改则需要手工修改Mock数据。
什么是CodeArts API CodeArts API是华为云API全生命周期管理一体化解决方案平台，支持开发者高效实现API设计、API开发、API测试、API托管、API运维、API变现的一站式体验。通过以API契约为锚点，CodeArts API保证API各阶段数据高度一
什么是CodeArts API API全生命周期管理一体化协作平台 CodeArts API是华为云API全生命周期管理一体化协作平台，支持开发者高效实现API设计、API开发、API测试、API托管、API运维、API变现的一站式体验。通过以API契约为锚点，CodeArts
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
