检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
ttps,并在定义的路径前自动添加了域名。添加的域名是在右上角选择的环境参数中定义的,单击左侧下拉箭头可在不同运行环境间切换,单击下拉箭头右上角按钮,可进行环境参数配置。 针对各个环境,默认提供变量“hostURL”参数作为添加到接口前的域名,从而拼接成完整地址。 可以看到对应环
对于不同类型变量的优先级顺序为: 临时变量 > 环境变量。 以上所有操作都是对本地值进行读写,而不会访问远程值。 对于请求的处理 pm.request pm.request对象可以在脚本中对请求数据进行访问,Request SDK 参考。在前置脚本中表示即将运行的请求,在后置脚本中,表示已经运行的请求。
开发时长,规范代码结构。 基于接口定义,CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块,接口文档界面右侧,即可看到“生成代码”的入口。 生成接口请求代码 单击“生成代码”下拉框,选择“生成接口请求代码”,弹出“生成接口请求代码”对话框。
对于不同类型变量的优先级顺序为: 临时变量 > 环境变量。 以上所有操作都是对本地值进行读写,而不会访问远程值。 对于请求的处理 pm.request pm.request对象可以在脚本中对请求数据进行访问,Request SDK 参考。在前置脚本中表示即将运行的请求,在后置脚本中,表示已经运行的请求。
接口的URL,客户端可以通过接口路径向服务端发起请求。以“/”开头,如:“/car”、“/car/{owner}”。 接口路径一般不包含域名和http、https协议名,如需加上域名进行调试,在调试功能页面有相应处理。 大括号“{}”中间的字符串表示Path参数。 不支持通过接口路径来添加Query参数,如:“/car
快速入门 使用CodeArts API快速设计并调试接口 访问CodeArts API产品首页,单击“网页版体验”,首次使用华为云账号登录CodeArts API的用户,系统将默认为该用户新建“示例项目”并进入项目,用户可基于示例接口认识API相关概念并熟悉产品使用方法。 使用API设计
API资产的简单介绍,方便资产在API中心门户网站按描述被搜索。 使用指南 API资产的使用指导,帮助API调用者了解API的使用方法。 资产域名 API资产的域名。 分类 选择资产行业分类,方便API资产在API中心门户网站按行业类别被搜索。 可见范围 公开:API资产创建成功后,所有用户都
开发时长,规范代码结构。 基于接口定义,CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块,接口文档界面右侧,即可看到“生成代码”的入口。 生成接口请求代码 单击“生成代码”下拉框,选择“生成接口请求代码”,弹出“生成接口请求代码”对话框。
单击实例名称,可进入实例详情页面,查看实例详情。 单击“购买运行时实例”旁的下拉框,选择“购买APIG实例”或者“购买ROMA实例”,根据界面提示购买相应实例,具体操作可参考购买APIG实例和购买ROMA实例。
编辑模式与API规范检查 CodeArts API在API设计界面提供代码编辑模式进行API设计,可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能,可以形成统一的设计规范,避免API设计不一致,提高API设计质量。AP
单击实例名称,可进入实例详情页面,查看实例详情。 单击“购买运行时实例”旁的下拉框,选择“购买APIG实例”或者“购买ROMA实例”,根据界面提示购买相应实例,具体操作可参考购买APIG实例和购买ROMA实例。
编辑模式与API规范检查 CodeArts API在API设计界面提供代码编辑模式进行API设计,可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能,可以形成统一的设计规范,避免API设计不一致,提高API设计质量。AP
使用CodeArts API服务 访问CodeArts API服务 授权使用CodeArts API 创建、管理项目 管理项目成员与角色权限
在用户组列表中,单击用户组操作的“用户组管理”。 在“可选用户”中选择需要添加至用户组中的用户。如未创建IAM用户,可在IAM控制台单击“用户 > 创建用户”,创建新的IAM用户,详细步骤请参照创建IAM用户章节。 单击“确定”,完成用户授权。 用户登录并验证权限。 用户登录CodeArts API,可正常使用产品,但不可创建项目。
正文:可手动输入文字,也可使用组件插入特定的内容,如:表格、超链接、图片;正文样式也可以使用组件进行调整;正文编辑支持全屏模式;在左侧编辑正文时,右侧会同步展示编辑内容,便于查看、修改样式等。 编辑完成后,单击右上角“保存”,左侧目录树同步刷新,界面会自动跳转到文档页面,展示名称、正文,上方标签
使用CodeArts API服务 访问CodeArts API服务 授权使用CodeArts API 创建、管理项目 管理项目成员与角色权限
TestPlan套餐后,项目中添加成员时会根据已购买服务的套餐人数自动分配服务访问权限,直到达到套餐人数规格。用户可以随时在CodeArts API首页单击“用户头像> 租户设置 > 服务级权限管理”,根据需要单击“测试计划”手动分配人员访问权限。 用户开通CodeArts套餐或CodeArts T
API网关注册 CodeArts API支持将状态为“已测完”或“已发布”的API注册到APIG网关实例,用户需要登录APIG实例,将已注册的API发布,API即可在APIG中正式生效。 API从注册到发布的管理流程如下: 准备工作 在使用API网关注册功能前,用户需要先购买AP
成员”,进入成员管理页面。默认是"成员"页签,展示当前项目下存在的成员。 添加本企业用户 本企业用户为企业用户在统一身份认证服务中已创建的IAM用户,即成员下显示的用户。 单击“添加成员”旁的下拉框,选择“添加本企业用户”。 弹出“添加本企业用户”对话框,勾选需要添加的成员,然后单击“下一步”。 选择项目角色,然后单击“完成”即可成功添加。
API中直接运行Postman脚本。 Postman中Run collection功能可以通过使用CodeArts API的API测试实现,支持接口的自动化测试,可视化界面灵活编排测试用例顺序,无需修改脚本,实现“零代码”快速生成测试用例,具体API测试操作可参照API测试导读。 父主题: 功能相关