检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
计费说明 CodeArts API属于开发者生态工具，使用软件开发生产线CodeArts的套餐计费规则，用户可以登录CodeArts控制台购买套餐。 CodeArts API将“快捷调试”，“API设计”，“API Mock”，“API发布”等特性免费开放给所有开发者，用户仅需要
使用CodeArts API快速设计并调试接口 访问CodeArts API产品首页，单击“网页版体验”，首次使用华为云账号登录CodeArts API的用户，系统将默认为该用户新建“示例项目”并进入项目，用户可基于示例接口认识API相关概念并熟悉产品使用方法。 使用API设计 示例项目
Mock语法说明 APIMock语法完全兼容Mock.js，并扩展了一些Mock.js没有的语法（uuid、正则表达式），Mock语法详见表1。 如现有Mock语法无法满足需求，建议使用正则表达式“@regexp”来实现灵活定制，正则表达式基本能满足各种特殊场景的需求。 表1 Mock语法
兼容Postman脚本语法，可以在CodeArts API中直接运行Postman脚本。 Postman中Run collection功能可以通过使用CodeArts API的API测试实现，支持接口的自动化测试，可视化界面灵活编排测试用例顺序，无需修改脚本，实现“零代码”快速生成测试用例，具体API测试操作可参照API测试导读。
移动Markdown（可选）。 单击并拖拽Markdown到目标目录后释放即可，移动成功后，目录树会自动刷新，Markdown文件的目录也会同步改变。 父主题： API设计
wn文件的目录也会同步改变。 Markdown文件只能在同一根目录下进行移动。 处于编辑页面的Markdown文件不能移动。 父主题： API设计
Mock语法说明 APIMock语法完全兼容Mock.js，并扩展了一些Mock.js没有的语法（uuid、正则表达式），Mock语法详见表1。 如现有Mock语法无法满足需求，建议使用正则表达式“@regexp”来实现灵活定制，正则表达式基本能满足各种特殊场景的需求。 表1 Mock语法
项目概况 进入CodeArts API目标项目后，默认进入项目概况页面，可查看项目下数据统计及API集合情况。 父主题： API设计
项目概况 进入CodeArts API目标项目后，默认进入项目概况页面，可查看项目下数据统计及API集合情况。 父主题： API设计
导出接口 在接口目录或已设计好的接口功能目录中，可以导出OpenAPI 3.0、Swagger 2.0版本格式的接口文件，且文件格式支持Yaml、Json。 单击接口目录或接口功能目录名称右侧，选择“导出”。 在弹出的“导出”窗口中，选择需要导出的数据格式及接口，单击“导出”。 父主题：
CodeArts API服务功能概览 功能名称 功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API，并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档，支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。 API Mock
导出接口 在接口目录或已设计好的接口功能目录中，可以导出OpenAPI 3.0、Swagger 2.0版本格式的接口文件，且文件格式支持Yaml、Json、Html。 单击接口目录或接口功能目录名称右侧，选择“导出”。 在弹出的“导出”窗口中，选择需要导出的数据格式及接口，单击“导出”。
CodeArt API的客户端与Web端差异 CodeArts API的客户端与Web端在主要功能使用上没有明显差异，但在少部分特定场景下，Web端因受限于浏览器的限制，无法支持如设置全局代理、使用快捷键等功能。推荐使用客户端，享受更全面的功能体验。 父主题： 功能相关
客户端访问 下载CodeArts API客户端 访问客户端 全局代理 父主题： 访问CodeArts API服务
全局代理 CodeArts API客户端版本支持设置全局网络代理，设置后，代理应用于所有联网服务，包括连接CodeArts API服务器和发送接口请求。 打开CodeArts API客户端后，单击右上角，进入设置页面。 单击“网络代理”，进入网络代理设置页面，可根据需要选择代理模
一致，所写即所得，以使用者视角定义API。 API设计规范检查 基于华为10年API治理经验，嵌入国内唯一“先进级”评级的API全生命周期管理规范。 支持API规范自动检查、自动纠错，提升API设计质量。 自动化代码和用例生成 API SDK代码和服务框架代码与API设计同源，基于API文档一键生成代码。
单击，弹出“接口审核”页面，默认可查看项目中所有“待审核”状态的API接口列表。 单击操作列的，弹出“审核详情”页面，可查看API接口变更前后的对比详情。 填写“审核意见”，单击“通过”或“拒绝”，完成API接口的审核。 对于已提交审核的API接口，提交人员可通过进入“接口审核”页面进行撤回审核的操作。
单击，弹出“接口审核”页面，默认可查看项目中所有“待审核”状态的API接口列表。 单击操作列的，弹出“审核详情”页面，可查看API接口变更前后的对比详情。 填写“审核意见”，单击“通过”或“拒绝”，完成API接口的审核。 对于已提交审核的API接口，提交人员可通过进入“接口审核”页面进行撤回审核的操作。
单击项目名称，进入目标项目，单击“项目设置 > 功能设置”，默认选择Mock设置页签，选择“开放访问”或“Token鉴权”，即可设置云端Mock访问权限。 父主题： API Mock
公共参数文档页面可以查看引用当前公共参数的API。 公共请求体 接口的公共请求体，默认请求类型为“application/json”。 支持设计Body体引用，并且在公共请求体的文档页面支持查看引用当前公共请求体的API。 公共示例 接口的公共示例，可在API设计请求体示例与返回响应的响应示
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
