检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
脚本能力 执行流程 前置脚本 后置脚本 pm对象API参考 使用JS类库 父主题： API设计
测试套件管理 创建测试套件 运行&报告 父主题： API测试
发布时间 下载链接 1.0.0 Windows X86 新特性： 客户端1.0.0版本正式发布，提供API表单化设计、文档管理、Mock&本地调试、快捷调试、规范校验、自动化测试及项目团队管理能力。 2023-05-22 - 2.0.0 Windows X86 新特性： 增加公共
API设计 API设计和API文档100%一致，所写即所得，以使用者视角定义API。 一键新建API、Markdown，Swagger标准文件一键导入。 Swagger 原生&结构表单API可视化编辑，专业API规范性自动化检查，设计问题辅助修复。 文档、设计、调试自动同步，API数据同源高效协同。
API设计 API设计和API文档100%一致，所写即所得，以使用者视角定义API。 一键新建API、Markdown，Swagger标准文件一键导入。 Swagger 原生&结构表单API可视化编辑，专业API规范性自动化检查，设计问题辅助修复。 文档、设计、调试自动同步，API数据同源高效协同。
践。 CodeArts API既可以帮助个人开发者一站式管理运营自己的API，摆脱工具、环境的束缚，快速实现API资产变现；也可以帮助企业规范化API流程，端到端提升设计、开发、测试、运维、运营等各组织的配合效率。 图1 CodeArts API使用场景
践。 CodeArts API既可以帮助个人开发者一站式管理运营自己的API，摆脱工具、环境的束缚，快速实现API资产变现；也可以帮助企业规范化API流程，端到端提升设计、开发、测试、运维、运营等各组织的配合效率。 图1 CodeArts API使用场景
API文档 API设计完成后，单击“保存”，会自动跳转到API文档页面。如果单击左侧导航栏中的API，默认进入API文档页面。 API文档页面展示了定义好的API信息，包括API路径、请求参数、请求体、返回响应等信息，可通过右侧文档目录切换至对应模块进行查看。在文档展示页面，
2023-11-30 1.0.0 Windows X86 新特性： 客户端1.0.0版本正式发布，提供API表单化设计、文档管理、Mock&本地调试、快捷调试、规范校验、自动化测试及项目团队管理能力。 2023-05-22
API文档 API设计完成后，单击“保存”，会自动跳转到API文档页面。如果单击左侧导航栏中的API，默认进入API文档页面。 API文档页面展示了定义好的API信息，包括API路径、请求参数、请求体、返回响应等信息，可通过右侧文档目录切换至对应模块进行查看。在文档展示页面，
在右侧“关键字库”界面，单击“导入接口”。 在弹出的“导入接口”页面，单击“点击添加文件或拖拽上传”，选择配置好的Swagger接口文档，单击“确定”，完成Swagger文件导入。 文档导入成功后，系统自动解析生成脚本模板，脚本模板包含了接口的基本描述信息。可以从“关键字库”界面单击“+”或直接拖拽
在右侧“关键字库”界面，单击“导入接口”。 在弹出的“导入接口”页面，单击“点击添加文件或拖拽上传”，选择配置好的Swagger接口文档，单击“确定”，完成Swagger文件导入。 文档导入成功后，系统自动解析生成脚本模板，脚本模板包含了接口的基本描述信息。可以从“关键字库”界面单击“+”或直接拖拽
数据结构被引用后，可以在数据结构的文档页面查看引用当前数据结构的API和模型。 公共响应 接口的公共响应返回结果，响应类型默认为“application/json”结构。 在设计API的响应体时，可以直接引用已设计好的公共响应。 公共响应文档页面可以查看引用当前公共响应的API。
数据结构被引用后，可以在数据结构的文档页面查看引用当前数据结构的API和模型。 公共响应 接口的公共响应返回结果，响应类型默认为“application/json”结构。 在设计API的响应体时，可以直接引用已设计好的公共响应。 公共响应文档页面可以查看引用当前公共响应的API。
使用方法。 使用API设计 示例项目中已经预设了不同请求的API示例和公共模型。单击任意接口，如“查询产品列表”。 默认进入“文档”页签，可通过右侧文档目录切换页面。 单击“设计”页签可以进入API设计页面，详细操作可参照API设计章节。 单击“调试”页签进入调试页面，详细操作可参照示例接口调试。
相应提示图标。 单击变更的API接口，在API“文档”页面单击“变更对比”。 弹出“变更对比”页面，可查看API接口变更前后的对比详情。 其他项目参与者有权限同步查看项目下任意API接口的变更详情。 提交审核 在API接口的“文档”页面单击“提交审核”，弹出“提交审核”页面，可查看接口变更前后的对比详情。
相应提示图标。 单击变更的API接口，在API“文档”页面单击“变更对比”。 弹出“变更对比”页面，可查看API接口变更前后的对比详情。 其他项目参与者有权限同步查看项目下任意API接口的变更详情。 提交审核 在API接口的“文档”页面单击“提交审核”，弹出“提交审核”页面，可查看接口变更前后的对比详情。
在接口的快捷调试页面单击，选择“保存为接口”。 在“保存为接口”页面输入接口名称，选择接口目录，单击“确定”，保存接口。 单击“API设计”，选择保存的接口，默认进入接口的文档页签。 单击“生成代码”下拉框，获取接口代码，具体操作请参照API开发。 父主题： 功能相关
API 介绍如何创建API设计及两种设计编辑模式 03:20 创建API设计 CodeArts API 介绍如何设置API设计规范 01:33 API规范性检查 CodeArts API 教你如何利用Mock功能及调试API 02:47 使用API Mock调试API CodeArts
单击“API设计”模块，可以看到示例项目中已经预设了不同请求的API示例和公共模型。 在“API设计”模块，单击任意接口，如“查询产品列表”。 默认进入“文档”页签，可通过右侧文档目录切换页面。 单击“设计”页签可以进入API设计页面，操作可参照API设计章节。 单击“调试”页签进入调试页面，操作可参照示例接口调试。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
