云服务器内容精选

  • 发布历史 记录了客户端版本发布历史,包括新特性、问题修复及优化等内容,用户可以在该页面下载最新版本客户端。 版本号 操作系统 OS支持 更新内容 发布时间 2.1.0 Windows X86 新特性: 项目支持分组功能、支持显示IPD类型的项目;新增系统公告能力,包含“测试计划”套餐试用提示;API设计模块增加项目概览;项目成员支持通过委托方式导入新成员; 2024-09-13 2.0.8 Windows X86 新特性: 项目管理模块新增定时导入swaggerURL能力;项目管理模块优化权限管理能力,与CodeArts权限同步; 快捷调试模块增加实际请求以及页面内名称修改能力。 2024-07-30 2.0.6 Windows X86 新特性: 项目管理支持YApi文件导入;快捷调试模块中,表单支持复制和另存为的便捷操作,URL支持引入环境变量;API设计模块中,接口导出功能支持Swagger2.0和JSON格式。 2024-06-04 2.0.5 Windows X86 新特性: API测试模块对接版本管理功能,支持版本切换; 版本管理新增测试用例数据,新增版本间导入测试用例功能; 导入功能优化:项目导入支持apifox文件前后置脚本导入;快捷调试支持Postman的Collection级别全量导入;API设计支持postman文件前后置脚本导入; 前后置脚本功能优化:支持创建或修改动态变量。 2024-05-10 2.0.4 Windows X86 新特性: 客户端新增未登录使用快捷调试能力;API设计模块新增设计审核能力、优化Swagger文件导入和Postman全量导入;API发布模块新增注册APIG网关能力。 2024-04-11 2.0.3 Windows X86 新特性: 项目管理模块新增导入Apifox项目能力;API测试模块新增关键字库功能,测试用例编排新增以下测试步骤模板:循环、if判断、URL请求、postman导入、分组。 2024-03-21 2.0.2 Windows X86 新特性: API设计模块中,新增前后置脚本功能;项目设置中,增加Mock功能设置页面。 2024-01-31 2.0.1 Windows X86 新特性: 增加扫码登录记住账号密码功能,新增快捷键能力,Postman文件可导入快捷调试,公共模型与快捷调试目录支持文件拖拽等功能。 2024-01-09 2.0.0 Windows X86 新特性: 增加公共组件编辑功能,不可视字符进行高亮提示,API测试增加默认变量MockURL。 2023-11-30 1.0.0 Windows X86 新特性: 客户端1.0.0版本正式发布,提供API表单化设计、文档管理、Mock&本地调试、快捷调试、规范校验、自动化测试及项目团队管理能力。 2023-05-22
  • 授权企业联邦账号 提供企业账户授权的启用、停用等操作。通过增加企业账户授权,您可以开放本企业账户的资源的使用权限给其他企业账户下用户。 华为云目前支持以下两种身份提供商类型: IAM 用户SSO:身份提供商中的用户登录华为云后,系统将自动匹配外部身份ID绑定的对应IAM子用户,从而拥有该子用户所在用户组的权限。此类型账号与普通的IAM账号授权相同。 虚拟用户SSO:身份提供商中的用户登录华为云后,系统为其自动创建虚拟用户信息,并按照身份转换规则授权。 两种身份提供商的适用场景及配置方法可参照身份供应商概述。 虚拟用户SSO需要先登录一次CodeArts API,项目拥有者/项目经理才可以在管理项目成员与角色页面中查询并添加该用户。 支持企业联邦账号登录并使用网页版CodeArts API,客户端暂不支持。
  • 授权IAM账号 如果用户需要对所拥有的CodeArts API服务 进行精细的权限管理,可以使用 统一身份认证 服务(Identity and Access Management,简称IAM),通过IAM,可以: 根据企业的业务组织,在华为云账号中,给不同职能部门的员工创建IAM用户,让员工拥有唯一安全凭证使用CodeArts API资源。 根据企业用户的职能,设置不同的访问权限,实现权限隔离。 CodeArts API支持的系统权限如下: DevCloud Console ReadOnlyAccess:软件开发生产线控制台只读权限,授权后可正常使用CodeArts API产品,但不可创建项目。 DevCloud Console FullAccess:软件开发生产线控制台管理员权限,拥有该权限的用户可以购买CodeArts。 ProjectMan ConfigOperations:设置新建项目权限。
  • 未登录使用 打开客户端,在登录页面单击“稍后再说”即可开始使用。未登录的状态下只支持创建一个环境及使用部分快捷调试功能。 创建环境 创建环境及环境变量请参照环境与环境变量进行设置与使用。 快捷调试 进入项目后,单击搜索框旁,可根据需要选择“新建快捷调试”进行新建快捷调试操作。 导入与导出功能需要登录后才可以继续使用。 前置脚本、后置脚本功能需要登录后才可继续使用。 切换登录状态 单击以下功能菜单可弹出登录页面,进行登录后可体验产品的全部功能。
  • API重新注册 CodeArts API提供API重新注册的功能,协助用户将已修改或不同版本的API重新注册到APIG实例。 在“API网关注册”页面,光标移动到API版本,可查看当前API的注册信息。 单击操作列的,弹出“重新注册API”对话框。 选择需要重新注册的API,单击“确定”,完成API的重新注册。 重新注册的API需要到APIG实例中完成发布API操作,才可完成API的上线。 对于项目中同名API的处理:如果项目中存在多个同名的API(URL、请求方式、名称相同),在重新注册操作时,需要用户从多个同名API中选择一个重新注册。APIG实例的同一个分组上不允许同名API重复注册。
  • 设计API 接口文档应针对以下要素进行设计: 接口基本信息 接口路径 请求方式 接口请求参数 接口返回响应 安全方案 接口基本信息 填写接口的基本信息,包括: 名称:接口名称。 摘要:接口的摘要信息。 状态:API生命周期的状态,包括设计中、联调中、测试中、测试完、已发布、将废弃、已废弃。 所属目录:接口在项目中所属的目录。 所属Tags:接口所属的Tags,可以直接选择所属目录信息当作所属Tags,也可以在所属Tags框中手动输入Tag名再回车来生成所属Tags。 描述:可添加接口的相关描述,包括接口功能、使用注意事项、使用场景定义等详细描述信息,接口描述支持通用Markdown语言编辑。 接口路径 接口的URL,客户端可以通过接口路径向服务端发起请求。以“/”开头,如:“/car”、“/car/{owner}”。 接口路径一般不包含 域名 和http、https协议名,如需加上域名进行调试,在调试功能页面有相应处理。 大括号“{}”中间的字符串表示Path参数。 不支持通过接口路径来添加Query参数,如:“/car?owner=zhangsan”。 支持创建100个项目中根目录。 请求方式 定义接口的请求方式,制定了客户端对服务端资源操作的方法,在API设计过程中,需要根据业务和操作类型选择合适的请求方式。 GET(获取):用于获取指定资源,使用查询参数传递参数,适用于读取资源和查询数据。 POST(提交):用于提交数据。POST请求可以传递请求体参数,适用创建新资源、提交表单数据或执行某些操作等场景。 PUT(更新):用于更新或替换服务端的指定资源。 DELETE(删除):用于删除服务端的指定资源。 OPTIONS(选项):用于获取服务器支持的http方法和资源的相关信息。可用于客户端与服务端之间的握手过程,了解服务器所支持的方法和功能。 HEAD(请求头):与GET类似,但只返回响应头部,不返回实体内容,用于获取资源的元信息,如:文件大小、修改日期等。 PATCH(补丁):用于对资源进行局部更新。PATCH请求类似于PUT请求,但是只更新资源的一部分。 TRACE(跟踪):用于简历与代理服务器的隧道连接,通常用于进行安全的SSL/TLS加密通信。 接口请求参数 Params、Path、Header、Cookies Query参数:接口请求中的一种参数传递方式,它通常用于传递一些可选的参数,比如过滤条件、排序方式、分页参数等。在URL中表现为末尾“?”后的字符串(如:“/car?owner=zhangsan”,那么“owner=zhangsan”即Query参数,其中“owner”为参数的key,“zhangsan”为参数的value)。 Path参数:也称为“路径参数”,是API请求中的一种参数传递方式。在URL中表现为大括号“{}”括起来的字符串(如:“/car/{owner}”,那么“{owner}”表示key为“owner”的Path参数)。 Header参数:请求头中的参数。 Cookies:类型为“小型文本文件”,是某些网站为了辨别用户身份,进行Session跟踪而储存在用户本地终端上的数据(通常经过加密),由用户客户端计算机暂时或永久保存的信息。 前置脚本:CodeArts API支持接口前置脚本操作,详见脚本能力。 后置脚本:CodeArts API支持接口后置脚本操作,详见脚本能力。 请求体 在发起http请求时,需要带上一些参数以便服务器处理,通过http请求体传递的参数被称为Body参数。Body参数包含在请求的主体部分中,通常是一些表单数据、JSON数据或者二进制数据。在发送请求时,会根据Body参数类型,自动在请求Header中添加对应Content-Type参数。若手工设置Content-Type的类型,则必须与Body的参数类型匹配,否则系统会自动忽略掉手动设置的Content-Type值。 none:无body参数。 application/json:json格式数据。Content-Type为 “application/json”。 application/xml:xml类型数据,用于标识文件和图像等没提类型,也可以标识结构化数据。Content-Type为 “application/xml”。 multipart/form-data:表单数据。Content-Type为 “multipart/form-data”。 application/x-www-form-urlencoded:将表单数据编码后传输到服务器。数据被编码为一系列键值对,每个键值对之间以&连接,并且键与值之间以=分隔。Content-Type为“application/x-www-form-urlencoded” 。 此外,还支持根据Body体数据结构自动生成示例,以及单击“智能导入”,根据输入的Json自动生成数据结构功能。 接口返回响应 返回响应的定义包含:返回响应的状态码、响应内容的数据结构、响应示例和响应头。 返回响应的状态码:通过加号来添加运行接口后可能的响应状态码,单击响应状态码可以对状态码进行修改。 响应内容的数据结构:规定响应内容的格式,分为“application/json”、“application/xml”、“text/plain”三种,“application/json”和“application/xml”两种情况下可以对响应内容的结构进行进一步定义,如:响应内容为“application/json”,规定json内容里的参数类型等。 响应示例:响应内容的示例。 响应头:返回响应的Header。 返回响应也可以直接引用公共模型中已定义好的“公共响应”,并且支持自动生成响应示例。 安全方案 OpenAPI规范中,安全模型对应OpenAPI3.0的components.securitySchemes。大部分的Web服务都需要经过身份认证才能访问,security就是用于描述API的安全信息和访问授权协议等信息的对象,Open API支持的最常见授权方案如下: API key HTTP Oauth2.0 OpenID Connect 安全方案引入需要在公共模型中建立安全模型,详见•安全模型。
  • 手动导入 通过主页面的“更多功能”选项或单击左上角搜索框旁边的,可以展示当前支持的导入选项,可根据需要选择。 导入文件 选择响应格式的文件并上传,然后选择文件中系统识别出来的接口和数据模型导入。 一个文件导入后,将会视为一个根目录,一个根目录中不允许存在URL相同的接口。 Postman支持Collections和Environment数据集ZIP包的全量导入,也支持单个Collection文件导入。 Postman支持接口和接口用例的前置脚本及后置脚本导入。 导入URL 选择“导入Swagger URL”,输入URL,即可完成文档导入。 通过Swagger URL导入时,需要填写json数据文件的URL,而非Swagger UI的URL。
  • 邀请其他企业用户 可以通过邀请其他企业用户,对当前项目进行查看或编辑。 单击“添加成员”旁的下拉框,选择“邀请其他企业用户”。 弹出“邀请其他企业用户”对话框,在“企业用户”输入框中输入企业用户ID,在“用户名称”输入框中输入需要邀请的用户名称后,单击右侧“添加用户”,可一次性添加同一企业不同用户。 单击“确定”导入其他企业成员,默认为“浏览者”身份权限。可通过设置项目成员角色修改成员角色与权限。
  • Markdown设计 新建Markdown,可通过以下三种方式完成。 方法一:单击“新建 Markdown”图标。 方法二:单击目录树搜索框右侧的,在弹出的下拉框中,选择“新建Markdown”。 方法三:在目录树中选择一个目录,单击右侧图标,在弹出的下拉框中,选择“新建Markdown”。 进入“新建标签页”,在该标签页可以编辑Markdown文件,主要包括:目录、名称、正文。 目录:在上一步中,如果通过方法一和方法二新建Markdown,目录初始内容为空,可以手动选择;如果通过方法三新建Markdown,目录会自动生成为选中的目录,也可以手动修改。 名称:可根据业务需要自定义命名,不能为空。命名规则:只支持中文、英文、下划线、数字和“.”,且以中英文开头,长度为3-64个字符。 正文:可手动输入文字,也可使用组件插入特定的内容,如:表格、超链接、图片;正文样式也可以使用组件进行调整;正文编辑支持全屏模式;在左侧编辑正文时,右侧会同步展示编辑内容,便于查看、修改样式等。 编辑完成后,单击右上角“保存”,左侧目录树同步刷新,界面会自动跳转到文档页面,展示名称、正文,上方标签页的名称也会更新为Markdown文件名称。 移动Markdown(可选)。 单击并拖拽Markdown到目标目录后释放即可,移动成功后,目录树会自动刷新,Markdown文件的目录也会同步改变。 Markdown文件只能在同一根目录下进行移动。 处于编辑页面的Markdown文件不能移动。 父主题: API设计
  • 测试用例导入 CodeArts API提供不同版本测试用例的导入功能。 在“版本管理”页面,单击目标版本操作列的,选择“导入”。 弹出“从版本导入测试用例”对话框。 填写导入信息,单击“确定”,完成测试用例的导入。 参数名称 说明 覆盖规则 勾选后,会覆盖编号重复用例和脚本,且无法回退。 版本选择 原版本:需要导入的测试用例版本。 目标版本:被导入测试用例的版本,不可更改。 用例选择 需要导入的测试用例列表。 因存量版本未在API测试模块中被同步创建,不可导入API测试未存在版本的测试用例。
  • 新建变量 在“环境参数”页面,单击,即可添加一个变量,根据需要填写变量信息: 参数项 说明 名称 当前环境变量参数名,可使用“$${参数名}”形式进行引用。 类型 包括:文本、随机字符串、随机整数、时间戳、格式化时间戳、生成UUID、Base64编码、MD5哈希值、密码或认证信息、SHA512编码。 值 当前环境变量的值,支持加密显示。 描述 根据不同类型,自动添加默认描述,也可根据设计需要自定义描述。 敏感变量 勾选为敏感变量后,云测对参数值加密存储,在测试结果日志中使用星号覆盖处理。敏感数据类型适用并不限于个人信息、鉴权信息等,如:姓名、地址、用户名等。 动态变量 动态参数的值可以在用例执行过程中被赋值。动态参数初始值可为空,被赋值之后,此处显示的是最新值。 动态参数赋值方法:在用例测试步骤“响应提取”的“赋值给环境动态参数”中设置后,测试执行时,响应提取的内容将被赋值给动态参数。
  • 参数使用 环境参数可以用于整个项目,如:快捷调试的参数、URL,测试步骤的参数、检查点、变量、URL等都可以引用环境参数。 环境参数的引用形式为“$${参数名}”,如:参数名为“hostname”,则可以使用“$${hostname}”来引用该参数。可以按环境上下文配置环境参数,如:类生产环境中hostname=stage.example.com,生产环境中hostname=prod.example.com。测试执行时可选择环境执行。
  • 接口路径 API调试页面的接口路径,可以选择http或https,并在定义的路径前自动添加了域名。添加的域名是在右上角选择的环境参数中定义的,单击左侧下拉箭头可在不同运行环境间切换,单击下拉箭头右上角按钮,可进行环境参数配置。 针对各个环境,默认提供变量“hostURL”参数作为添加到接口前的域名,从而拼接成完整地址。 可以看到对应环境“默认环境”中的“hostURL”参数的值“127.0.0.1:8080”被添加到接口URL前,作为整个路径的域名。鼠标悬浮在路径前,提示次前置URL来自于哪一环境,单击环境名称,可直接跳转至相应环境下进行编辑。 路径中大括号“{}”中的字符串表示Path参数。 路径中“?”后的字符串表示Query参数。 如果在调试页面路径栏下方的Query属性框中,对Query参数进行修改,路径中的Query参数也会同步变化。
  • 请求体 在Body页签中,可以查看请求体,目前支持的请求体有如下几类: none:无body参数。 form-data:Content-Type为“multipart/form-data”,可以输入请求体中每个参数的类型、名称和值。 application/x-www-form-urlencoded:Content-Type为“application/x-www-form-urlencoded”,可以输入请求体中每个参数的名称和值。 raw:在文本框中输入文本内容,在“raw”选项旁边可以下拉选择输入文本内容格式,如Text和Json。 请求参数的默认值均来自API设计的样例值。 在API调试页面修改请求参数,不能保存至API设计与API文档中。
  • 创建测试套件 自动化测试套件,实现用例串行/并行执行的策略,测试用例分块加速能力,有效提高资源池利用率,减少任务阻塞情况。并且可提前拦截产品缺陷,更加快速地发现问题。 可通过以下两种入口新建测试套件。 入口一:单击主页面的“新建测试套件”选项。 入口二:单击左侧测试用例旁边的,选择下拉选项中的“新建测试套件”选项。 在“新建测试套件”页面,填写用例名称与描述。 单击,弹出“添加测试用例”对话框,选择需要添加到测试套件的测试用例,单击“确定”。 单击,弹出“执行策略”对话框,根据需要配置执行策略,单击“确定”。 定时类型:执行一次、周期性重复执行,周期性指设置一个执行频率,测试套按照这个频率周期重复执行。 任务开始时间:立即执行、指定开始时间。 执行时间区间:全天执行、指定执行区间,即指定套件执行的时间段。 用例超时时间:设置每个用例的最长执行时间,超过时间,用例则超时失败。 任务继续执行,直到最后一个用例执行完毕。可设置分钟级,小时级,天级。 回到当前测试套件页面,单击右上角“保存“,完成自动化测试套件创建。 父主题: 测试套件管理