检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
公共模型 公共模型提供API设计时所需公共数据的定义，在设计API的Body请求体或返回响应时，如果需要使用某种数据模型、公共响应等，可直接引用对应的公共模型，单击“公共模型”搜索框右侧，新建不同类型公共模型，CodeArts API提供以下7种公共模型定义：数据模型、公共响应、
公共模型 公共模型提供API设计时所需公共数据的定义，在设计API的Body请求体或返回响应时，如果需要使用某种数据模型、公共响应等，可直接引用对应的公共模型，单击“公共模型”搜索框右侧，新建不同类型公共模型，CodeArts API提供以下7种公共模型定义：数据模型、公共响应、
管理项目成员与角色权限 管理成员与角色 管理角色权限 角色与操作权限说明 父主题： 使用CodeArts API服务
编辑模式与API规范检查 CodeArts API在API设计界面提供代码编辑模式进行API设计，可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能，可以形成统一的设计规范，避免API设计不一致，提高API设计质量。AP
退出项目只对本人可见。 用户被添加为项目成员后，如果不再使用项目，也可以选择主动退出项目。 用户仅可以退出非自己创建项目。 父主题： 管理项目成员与角色权限
编辑模式与API规范检查 CodeArts API在API设计界面提供代码编辑模式进行API设计，可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能，可以形成统一的设计规范，避免API设计不一致，提高API设计质量。AP
删除定时导入任务 Y Y N N N N N N N N N 执行 执行定时导入任务 Y Y N N N N N N N N N 父主题： 管理项目成员与角色权限
API设计 项目概况 API设计 接口审核 编辑模式与API规范检查 公共模型 Markdown设计 API调试 脚本能力
退出项目成员 在“成员”列表页面中单击自己所在行后的，可以主动退出项目。 退出项目只对本人可见。 用户仅可以退出非自己创建项目。 父主题： 管理项目成员与角色权限
API设计 项目概况 API设计 接口审核 编辑模式与API规范检查 公共模型 Markdown设计 API调试 脚本能力
API支持的最常见授权方案如下： API key HTTP Oauth2.0 OpenID Connect 安全方案引入需要在公共模型中建立安全模型，详见•安全模型。 API文档 API设计完成后，单击“保存”，会自动跳转到API文档页面。如果单击左侧导航栏中的API，默认进入API文档页面。
在“导入项目”对话框上输入项目名称，单击“确定”。 弹出“导入预览”对话框，选择“接口”或“数据模型”，可预览所有导入数据，然后单击“导入”。 弹出导入进度对话框，可查看导入进度。 导入完成后，可进入导入项目，查看导入的接口和数据模型。 目前导入接口的前置操作和后置操作仅支持自定义脚本导入。 YApi项目导入
删除定时导入任务 Y Y N N N N N N N N N 执行 执行定时导入任务 Y Y N N N N N N N N N 父主题： 管理项目成员与角色权限
管理项目成员与角色权限 管理成员与角色 管理角色权限 角色与操作权限说明 父主题： 使用CodeArts API服务
环境与环境变量 在开发项目中，不同阶段对应不同环境，例如：前端与后端的开发人员需要在研发环境做功能联调，测试人员需要在测试环境测试，上线生产环境前也需要在预发环境验证，不同环境对应不同的前置URL和接口参数值，为了方便快速切换运行环境，快速修改前置URL等参数，CodeArts API提供了环境管理功能。
通过主页面的“更多功能”选项或单击左上角搜索框旁边的，可以展示当前支持的导入选项，可根据需要选择。 导入文件 选择响应格式的文件并上传，然后选择文件中系统识别出来的接口和数据模型导入。 一个文件导入后，将会视为一个根目录，一个根目录中不允许存在URL相同的接口。 Postman支持Collections和Envir
在“导入项目”对话框上输入项目名称，单击“确定”。 弹出“导入预览”对话框，选择“接口”或“数据模型”，可预览所有导入数据，然后单击“导入”。 弹出导入进度对话框，可查看导入进度。 导入完成后，可进入导入项目，查看导入的接口和数据模型。 目前导入接口的前置操作和后置操作仅支持自定义脚本导入。 YApi项目导入
环境与环境变量 在开发项目中，不同阶段对应不同环境，例如：前端与后端的开发人员需要在研发环境做功能联调，测试人员需要在测试环境测试，上线生产环境前也需要在预发环境验证，不同环境对应不同的前置URL和接口参数值，为了方便快速切换运行环境，快速修改前置URL等参数，CodeArts API提供了环境管理功能。
Swagger Postman（支持Collections和Environment数据集ZIP包） Jmeter Swagger URL 约束与限制 导入文件时，一个文件导入后，将会视为一个根目录，一个根目录中不允许存在URL相同的接口。 手动导入 通过主页面的“更多功能”选项或单击
项目”并进入项目，用户可基于示例接口认识API相关概念并熟悉产品使用方法。 使用API设计 示例项目中已经预设了不同请求的API示例和公共模型。单击任意接口，如“查询产品列表”。 默认进入“文档”页签，可通过右侧文档目录切换页面。 单击“设计”页签可以进入API设计页面，详细操作可参照API设计章节。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
