检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API提供API规范性检查。 通过规范性检查功能，可以形成统一的设计规范，避免API设计不一致，提高API设计质量。API规范设计定义，请参照设置API设计规范。 编辑模式 规范性检查 设置API设计规范 单击项目名称，进入目标项目，单击“项目设置 > 设计规范设置”，进入“设计规范设置”页面。
API提供API规范性检查。 通过规范性检查功能，可以形成统一的设计规范，避免API设计不一致，提高API设计质量。API规范设计定义，请参照设置API设计规范。 编辑模式 规范性检查 设置API设计规范 单击项目名称，进入目标项目，单击“项目设置 > 设计规范设置”，进入“设计规范设置”页面。
填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称，限制128个字符。 项目描述 否 项目描述，限制1024个字符。 单击“确定”，完成项目创建。 CodeArts API还支持查看和使用在软件开发生产线CodeArts中创建的IPD项目。
接口文档应针对以下要素进行设计： 接口基本信息 接口路径 请求方式 接口请求参数 接口返回响应 安全方案 接口基本信息 填写接口的基本信息，包括： 名称：接口名称。 摘要：接口的摘要信息。 状态：API生命周期的状态，包括设计中、联调中、测试中、测试完、已发布、将废弃、已废弃。 所属目录：接口在项目中所属的目录。
力。API全生命周期管理也是DevOps实践的一个关键组成部分，通过提供标准化、自动化的API创建、测试、部署和管理流程，支持DevOps中的快速迭代、高质量软件交付和持续改进的目标。了解更多软件开发生产线相关信息，请前往查看更多相关介绍。
API”。 项目信息 CodeArts API项目名称和ID。 API接口 当导入方式为“CodeArts API”时，支持勾选部分接口导入，如果导入全部接口，则忽略此参数。 表2 资产基本信息 参数名称 说明 资产名称 自定义API资产的名称。 图标 为API资产设置一个图标。 资产简介
对不同版本API接口进行直接对比。 创建版本 单击项目名称，进入目标项目，单击“项目设置 > 版本管理”，进入“版本管理”页面。 单击“新增版本”，填写版本号和描述，默认勾选“同步创建测试版本”。 单击“确定”。 单击项目名称下“基线”旁的下拉框，可快速切换版本（支持根据版本名快速搜索），并对版本进行编辑。
填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称，限制128个字符。 项目描述 否 项目描述，限制1024个字符。 单击“确定”，完成项目创建。 CodeArts API还支持查看和使用在软件开发生产线CodeArts中创建的IPD项目。
什么是CodeArts API CodeArts API是华为云API全生命周期管理一体化解决方案平台，支持开发者高效实现API设计、API开发、API测试、API托管、API运维、API变现的一站式体验。通过以API契约为锚点，CodeArts API保证API各阶段数据高度一
接口文档应针对以下要素进行设计： 接口基本信息 接口路径 请求方式 接口请求参数 接口返回响应 安全方案 接口基本信息 填写接口的基本信息，包括： 名称：接口名称。 摘要：接口的摘要信息。 状态：API生命周期的状态，包括设计中、联调中、测试中、测试完、已发布、将废弃、已废弃。 所属目录：接口在项目中所属的目录。
固定地址，其他成员可以通过这个地址访问云端Mock Server。 云端Mock的优势： Mock数据统一管理 配置数据团队共享 单击项目名称，进入目标项目，单击“项目设置 > 功能设置”，默认选择Mock设置页签，选择“开放访问”或“Token鉴权”，即可设置云端Mock访问权限。
Path不支持“存在”和“不存在”类型。 表达式支持Mock.js语法，具体使用方式可参考Mock语法说明。 返回响应 Mock服务支持从状态码、响应头、响应体三个维度配置请求的响应。 状态码：必填项，参考http状态码。 响应头：选填项，输入响应头的名称和值，配置希望返回的响应头。
创建成功，在“自定义角色”中显示新的角色名称。 对新创建的角色，可以完成以下操作。 表2 表2 管理自定义角色 操作 说明 编辑角色权限 操作方式与修改系统角色的权限相同。 修改角色名称 单击角色名称后的，选择“修改角色名称”。 输入修改后的角色名称，单击“确定”。 修改成功后，页面中显示更新后的角色名称。 删除角色
固定地址，其他成员可以通过这个地址访问云端Mock Server。 云端Mock的优势： Mock数据统一管理 配置数据团队共享 单击项目名称，进入目标项目，单击“项目设置 > 功能设置”，默认选择Mock设置页签，选择“开放访问”或“Token鉴权”，即可设置云端Mock访问权限。
Path不支持“存在”和“不存在”类型。 表达式支持Mock.js语法，具体使用方式可参考Mock语法说明。 返回响应 Mock服务支持从状态码、响应头、响应体三个维度配置请求的响应。 状态码：必填项，参考http状态码。 响应头：选填项，输入响应头的名称和值，配置希望返回的响应头。
支持Swagger编辑器原生开发者体验。 API设计和API文档 100% 一致，所写即所得，以使用者视角定义API。 API设计规范检查 基于华为10年API治理经验，嵌入国内唯一“先进级”评级的API全生命周期管理规范。 支持API规范自动检查、自动纠错，提升API设计质量。 自动化代码和用例生成 API S
支持Swagger编辑器原生开发者体验。 API设计和API文档 100% 一致，所写即所得，以使用者视角定义API。 API设计规范检查 基于华为10年API治理经验，嵌入国内唯一“先进级”评级的API全生命周期管理规范。 支持API规范自动检查、自动纠错，提升API设计质量。 自动化代码和用例生成 API S
创建成功，在“自定义角色”中显示新的角色名称。 对新创建的角色，可以完成以下操作。 表2 表2 管理自定义角色 操作 说明 编辑角色权限 操作方式与修改系统角色的权限相同。 修改角色名称 单击角色名称后的，选择“修改角色名称”。 输入修改后的角色名称，单击“确定”。 修改成功后，页面中显示更新后的角色名称。 删除角色
插件管理 在插件管理页面中可以查看APIG和ROMA实例，还可以根据需要购买实例。 单击项目名称，进入目标项目，单击“项目设置 > 插件管理”，进入“插件管理”页面。 单击实例名称，可进入实例详情页面，查看实例详情。 单击“购买运行时实例”旁的下拉框，选择“购买APIG实例”或者
插件管理 在插件管理页面中可以查看APIG和ROMA实例，还可以根据需要购买实例。 单击项目名称，进入目标项目，单击“项目设置 > 插件管理”，进入“插件管理”页面。 单击实例名称，可进入实例详情页面，查看实例详情。 单击“购买运行时实例”旁的下拉框，选择“购买APIG实例”或者
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
