检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
数据源格式 支持OpenApi格式。 数据源URL 数据源URL地址。 认证方式 选择认证方式: 无认证:表示不需要认证。 华为云APIG-AKSK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求,关于AK/SK获取方式请参照AK/SK认证。
API测试导读 API测试能力简介 CodeArts API的“API测试”功能来源于CodeArts TestPlan的“接口自动化测试”能力,且与CodeArts TestPlan的数据同源。 CodeArts API针对API做测试,更贴近API的设计、开发到测试的同步场景。
API测试导读 API测试能力简介 CodeArts API的“API测试”功能来源于CodeArts TestPlan的“接口自动化测试”能力,且与CodeArts TestPlan的数据同源。 CodeArts API针对API做测试,更贴近API的设计、开发到测试的同步场景。
弹出“邀请其他企业用户”对话框,在“企业用户”下拉列表框中选择被邀请用户所属的账号,选择邀请方式并输入对应ID,单击“确定”。 用户ID:被邀请用户的ID,通过“我的凭证 ”获取“IAM用户ID”。获取方式请参考API凭证。 委托ID:被邀请账号中已创建的委托ID,通过IAM服务中的“委托”页面获取。
产品优势 API全流程高效协同 API设计、开发、测试等关键开发流程一站式协同。 API托管、运维、变现等运营流程一体化协同。 API全流程数据自动同步。 灵活API设计方式 支持表单可视化编辑设计API。 支持Swagger编辑器原生开发者体验。 API设计和API文档 100%
API开发 CodeArts API支持生成接口请求代码和业务代码,缩短前后端开发时长,规范代码结构。 基于接口定义,CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块,接口文档界面右侧,即可看到“生成代码”的入口。 生成接口请求代码 单击“
高级提取类型 可选项,使用高级提取类型,辅助提取检查点信息,若选择不涉及,则视为不使用额外的方式匹配。 目前有两种方式: 字符串提取,也就是字符串的截取。 正则表达式,即使用正则方式对来源字符串进行过滤。 高级提取类型优先使用字符串提取功能,若不能满足需求可考虑使用正则表达式。
数据源格式 支持OpenApi格式。 数据源URL 数据源URL地址。 认证方式 选择认证方式: 无认证:表示不需要认证。 华为云APIG-AKSK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求,关于AK/SK获取方式请参照AK/SK认证。
编辑模式与API规范检查 CodeArts API在API设计界面提供代码编辑模式进行API设计,可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能,可以形成统一的设计规范,避免API设计不一致,提高API设计质量。AP
编辑模式与API规范检查 CodeArts API在API设计界面提供代码编辑模式进行API设计,可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能,可以形成统一的设计规范,避免API设计不一致,提高API设计质量。AP
关必填信息,用于API设计中“安全方案”的引用。在安全模型的文档页可以查看引用当前安全模型的API。 公共响应头 接口的公共响应头,在API设计中“返回响应”中响应头可进行公共响应头的引用。在公共响应头的文档页可以查看引用当前公共响应头的API。 父主题: API设计
什么是CodeArts API API全生命周期管理一体化协作平台 CodeArts API是华为云API全生命周期管理一体化协作平台,支持开发者高效实现API设计、API开发、API测试、API托管、API运维、API变现的一站式体验。通过以API契约为锚点,CodeArts API保证API
API开发 CodeArts API支持生成接口请求代码和业务代码,缩短前后端开发时长,规范代码结构。 基于接口定义,CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块,接口文档界面右侧,即可看到“生成代码”的入口。 生成接口请求代码 单击“
个字符。 数据源格式 支持OpenAPI 3.0、Swagger 2.0格式。 数据源URL 支持YAML、JSON。 第三方URL 第三方URL地址。 Auth 推送URL的认证类型。 No Auth:表示无认证。 API Key:使用 API Key 进行身份验证。 Bearer
CodeArts API提供友商项目导入功能,目前支持API Fox项目及YApi项目中的API设计导入CodeArts API中。 API Fox项目导入 导出数据 打开API Fox对应项目,单击“项目设置 > 导出数据”,进入“导出数据”页面。 选择“Apifox”数据格式,单击”导出”,完成导出。
CodeArts API提供友商项目导入功能,目前支持API Fox项目及YApi项目中的API设计导入CodeArts API中。 API Fox项目导入 导出数据 打开API Fox对应项目,单击“项目设置 > 导出数据”,进入“导出数据”页面。 选择“Apifox”数据格式,单击”导出”,完成导出。
开启审核功能后,在项目下API设计中创建、删除、修改API的操作均会被记录为草稿内容,需要通过审核后生效。 关闭审核功能 在“审核设置”页签,单击,弹出“审核设置”对话框。 根据提示输入“CLOSE”后,单击“确定”,关闭审核功能。 关闭审核功能后,在项目下API设计中创建、删除、修改API的操作
提交审核 审核功能开启后,对于API接口的操作都需要提交审核并通过后才可生效。 查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情。
开启审核功能后,在项目下API设计中创建、删除、修改API的操作均会被记录为草稿内容,需要通过审核后生效。 关闭审核功能 在“审核设置”页签,单击,弹出“审核设置”对话框。 根据提示输入“CLOSE”后,单击“确定”,关闭审核功能。 关闭审核功能后,在项目下API设计中创建、删除、修改API的操作
审核功能开启后,对于API接口的操作都需要提交审核并通过后才可生效。 约束与限制 审核流程结束前,提交审核的API接口将处于锁定状态,不可编辑和删除。 查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。