检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
接口的URL,客户端可以通过接口路径向服务端发起请求。以“/”开头,如:“/car”、“/car/{owner}”。 接口路径一般不包含域名和http、https协议名,如需加上域名进行调试,在调试功能页面有相应处理。 大括号“{}”中间的字符串表示Path参数。 不支持通过接口路径来添加Query参数,如:“/car
API发布 API网关注册
协议类型的代理。 代理服务器:需输入代理服务器地址和端口。 身份认证:请查看身份认证。 Proxy Bypass:无需进行代理转发的IP或域名,可填入多个,以英文逗号进行分隔。 身份认证 在选择“使用系统代理”与“自定义”代理两种代理模式时,支持配置身份认证信息。 开启配置身份认证开关后,CodeArts
产品优势 API全流程高效协同 API设计、开发、测试等关键开发流程一站式协同。 API托管、运维、变现等运营流程一体化协同。 API全流程数据自动同步。 灵活API设计方式 支持表单可视化编辑设计API。 支持Swagger编辑器原生开发者体验。 API设计和API文档 100%
客户端新增未登录使用快捷调试能力;API设计模块新增设计审核能力、优化Swagger文件导入和Postman全量导入;API发布模块新增注册APIG网关能力。 2024-04-11 2.0.3 Windows X86 新特性: 项目管理模块新增导入Apifox项目能力;API测试模块新增关键字库
测试人员 参与者 浏览者 注册APIG 创建 注册API Y Y N N Y N N N N N N 查看 查看注册API Y Y Y Y Y Y Y Y Y Y Y 编辑 重新注册API Y Y N N Y N N N N N N 删除 删除注册API Y Y N N Y N N
Markdown设计 新建Markdown,可通过以下三种方式完成。 方法一:单击目录树搜索框右侧的,在弹出的下拉框中,选择“新建Markdown”。 方法二:在目录树中选择一个目录,单击右侧图标,在弹出的下拉框中,选择“新建Markdown”。 进入“新建标签页”,在该标签页可
ck页面。 目录级Mock规则管理页面 单击“API设计”,然后单击接口目录右侧的,选择“Mock规则管理”。 进入“Mock规则管理”页面,可以查看当前目录下所有接口和接口对应的Mock规则。 接口级高级Mock页面 单击“API设计”,选择对应的接口。 单击“高级Mock”页
高级提取类型 可选项,使用高级提取类型,辅助提取响应结果信息,若选择不涉及则视为不使用额外的方式匹配。 目前有两种方式: 字符串提取,也就是字符串的截取。 正则表达式,即使用正则方式对来源字符串进行过滤。 高级提取类型优先使用字符串提取功能,若不能满足需求可考虑使用正则表达式。
API。但是离线状态下只支持使用默认环境及部分快捷调试功能,无法使用快捷调试中的导入、导出及脚本功能,且离线时快捷调试的接口与登录状态下不同步,具体离线使用操作请参照未登录使用客户端。 父主题: 功能相关
Management,简称IAM),通过IAM,可以: 根据企业的业务组织,在华为云账号中,给不同职能部门的员工创建IAM用户,让员工拥有唯一安全凭证使用CodeArts API资源。 根据企业用户的职能,设置不同的访问权限,实现权限隔离。 CodeArts API支持的系统权限如下: DevCloud
测试流程控制条件 在测试用例中,可能会有复杂的测试场景,因此CodeArts API提供了多种流程控制条件:循环、判断、分组、等待时间。 循环 当测试步骤需要重复执行时,可以指定重复执行次数。 进入接口自动化用例编辑的“脚本”页签,单击“循环”。 设置循环次数。 循环中可添加URL请求、判断、分组、等待、测试关键字。
API的用户,系统将默认为该用户新建“示例项目”并进入项目,用户可基于示例接口认识API相关概念并熟悉产品使用方法。 使用API设计 示例项目中已经预设了不同请求的API示例和公共模型。单击任意接口,如“查询产品列表”。 默认进入“文档”页签,可通过右侧文档目录切换页面。 单击“设计”页签可以进
在设计API的Body请求体或返回响应时,如果需要使用某种数据模型、公共响应等,可直接引用对应的公共模型,单击“公共模型”搜索框右侧,新建不同类型公共模型,CodeArts API提供以下7种公共模型定义:数据模型、公共响应、公共参数、公共请求体、公共示例、安全模型、公共响应头。
数据源格式 支持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支持生成接口请求代码和业务代码,缩短前后端开发时长,规范代码结构。 基于接口定义,CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块,接口文档界面右侧,即可看到“生成代码”的入口。 生成接口请求代码 单击“
API设计 项目概况 API设计 接口审核 编辑模式与API规范检查 公共模型 Markdown设计 API调试 脚本能力
API测试 API测试导读 测试用例管理 测试套件管理
个字符。 数据源格式 支持OpenAPI 3.0、Swagger 2.0格式。 数据源URL 支持YAML、JSON。 第三方URL 第三方URL地址。 Auth 推送URL的认证类型。 No Auth:表示无认证。 API Key:使用 API Key 进行身份验证。 Bearer