检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
认证类—OAuth2ForOneAccess 数据库操作类 数据库类—MySQLQuery 数据库类—MySQLUpdate 数据库类—MySQLInsert 数据库类—MySQLDelete 数据库类—OpenGaussQuery 数据库类—OpenGaussUpdate 数据库类—OpenGaussInsert
导出接口 在接口目录或已设计好的接口功能目录中,可以导出OpenAPI 3.0、Swagger 2.0版本格式的接口文件,且文件格式支持Yaml、Json。 单击接口目录或接口功能目录名称右侧,选择“导出”。 在弹出的“导出”窗口中,选择需要导出的数据格式及接口,单击“导出”。 父主题:
ode。 导入时间间隔 选择导入时间间隔: 按小时:1~24小时。 按天:1~100天。 导入版本 选择需要导入的API版本。 根目录 选择需要导入的根目录。支持手动输入新的目录名称或为空,为空时将默认以任务名称命名。 单击“确定”,完成定时导入任务创建。 在“定时导入”页面单击
弹出“导入预览”对话框,选择“接口”或“数据模型”,可预览所有导入数据,然后单击“导入”。 弹出导入进度对话框,可查看导入进度。 导入完成后,可进入导入项目,查看导入的接口和数据模型。 目前导入接口的前置操作和后置操作仅支持自定义脚本导入。 YApi项目导入 导出数据 打开YApi对应项目,单击“数据管理”,进入“数据管理”页面。
弹出“导入Postman文件”对话框,选择需要导入的Postman文件。 Collection数据文件的导入 弹出“导入”对话框,选择需要导入的接口,单击“导入”完成数据迁移。 Collections和Environments数据集ZIP包的导入 弹出“导入”对话框,选择需要导入的接口和环境变量,单击“导入”完成数据迁移。
原生&结构表单API可视化编辑,专业API规范性自动化检查,设计问题辅助修复。 文档、设计、调试自动同步,API数据同源高效协同。 内置Mock代理,Mock数据自动识别,全局Mock一体化设置。 API接口一键调试,调试结果一键自动生成测试用例。 支持区域: 北京四 API设计 API调试 Markdown设计
认证类—OAuth2ForOneAccess 数据库操作类 数据库类—MySQLQuery 数据库类—MySQLUpdate 数据库类—MySQLInsert 数据库类—MySQLDelete 数据库类—OpenGaussQuery 数据库类—OpenGaussUpdate 数据库类—OpenGaussInsert
导入/导出接口 导入接口 定时导入接口 导出接口 父主题: 导入与导出
一键新建API、Markdown,Swagger标准文件一键导入。 Swagger 原生&结构表单API可视化编辑,专业API规范性自动化检查,设计问题辅助修复。 文档、设计、调试自动同步,API数据同源高效协同。 内置Mock代理,Mock数据自动识别,全局Mock一体化设置。 API接口一键调试,调试结果一键自动生成测试用例。
确认云端MockURL,详细Mock规则查询请参照高级Mock。 单击“发送”。 在响应体中选择美化体查看响应。 高级Mock CodeArts API提供高级Mock功能,可以查询和定义调试接口的Mock规则。 单击接口的“高级Mock”页签,可以查看该接口对应的Mock规则。 单击“查询产品列表”,弹出“编辑Mock规则”页面。
和操作类型选择合适的请求方式。 GET(获取):用于获取指定资源,使用查询参数传递参数,适用于读取资源和查询数据。 POST(提交):用于提交数据。POST请求可以传递请求体参数,适用创建新资源、提交表单数据或执行某些操作等场景。 PUT(更新):用于更新或替换服务端的指定资源。
运行&报告 运行测试套件 在待执行测试套件详情页面,单击“执行”,运行测试套件。 查看测试报告 页面右侧可快速查看最近测试结果。 单击测试结果的,可查看测试结果的运行报告。 单击”更多执行历史”,可查看历史测试结果的运行报告。 父主题: 测试套件管理
单击“项目设置 > 导出数据”,默认进入“第三方推送”页签。 单击“新建”,弹出“新增同步任务”窗口。 配置任务参数,参数配置请参考下表。 参数 配置说明 任务名称 同步任务名称,只允许输入字母、汉字、数字、下划线、中划线,长度3-64个字符。 数据源格式 支持OpenAPI
支持授权IAM账号和企业联邦账号使用CodeArts API。 约束与限制 虚拟用户SSO需要先登录一次CodeArts API,项目拥有者/项目经理才可以在成员管理页面中查询并添加该用户。 支持企业联邦账号登录并使用网页版CodeArts API,客户端暂不支持。 授权IAM账号 如果用户需要对所拥有的CodeArts
导出接口 在接口目录或已设计好的接口功能目录中,可以导出OpenAPI 3.0、Swagger 2.0版本格式的接口文件,且文件格式支持Yaml、Json、Html。 单击接口目录或接口功能目录名称右侧,选择“导出”。 在弹出的“导出”窗口中,选择需要导出的数据格式及接口,单击“导出”。
确认云端MockURL,详细Mock规则查询请参照高级Mock。 单击“发送”。 在响应体中查看响应。 高级Mock CodeArts API提供高级Mock功能,可以查询和定义调试接口的Mock规则。 单击接口的“高级Mock”页签,可以查看该接口对应的Mock规则。 单击“查询产品列表”,弹出“编辑Mock规则”页面。
定义接口的请求方式,制定了客户端对服务端资源操作的方法,在API设计过程中,需要根据业务和操作类型选择合适的请求方式。 GET(获取):用于获取指定资源,使用查询参数传递参数,适用于读取资源和查询数据。 POST(提交):用于提交数据。POST请求可以传递请求体参数,适用创建新资源、提交表单数据或执行某些操作等场景。
两种身份提供商的适用场景及配置方法可参照身份供应商概述。 虚拟用户SSO需要先登录一次CodeArts API,项目拥有者/项目经理才可以在成员管理页面中查询并添加该用户。 支持企业联邦账号登录并使用网页版CodeArts API,客户端暂不支持。 父主题: 使用CodeArts API服务
产品优势 API全流程高效协同 API设计、开发、测试等关键开发流程一站式协同。 API托管、运维、变现等运营流程一体化协同。 API全流程数据自动同步。 灵活API设计方式 支持表单可视化编辑设计API。 支持Swagger编辑器原生开发者体验。 API设计和API文档 100%
公共响应头。 数据模型 数据模型和编程语言里的数据结构概念类似,主要用于接口设计场景中的“返回响应”和json/xml类型的“Body参数”。 在设计API的Body体或响应体时,可以直接引用公共数据结构。 数据结构被引用后,可以在数据结构的文档页面查看引用当前数据结构的API和模型。