检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
编辑模式与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规范检查 公共模型 Markdown设计 API调试 脚本能力
为项目各个角色设置不同操作权限,包括项目基本信息的编辑和归档、角色及权限的设置和成员设置,还可以根据需要自定义角色类型并授权。 修改系统角色的权限 单击项目名称,进入目标项目,单击“项目设置 > 权限管理 > 权限”,进入权限管理页面。 选择左侧角色名称,在右侧单击“编辑”可为角色勾选设置不同操作权限。
审核功能开启后,对于API接口的操作都需要提交审核并通过后才可生效。 约束与限制 审核流程结束前,提交审核的API接口将处于锁定状态,不可编辑和删除。 查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。
Mock规则设计 Mock语法说明 API测试 API测试与API设计同源,设计示例一键导入测试步骤。 测试步骤免编辑一键导入,测试数据契约化自动同步。 测试参数、断言、数据提取可视化编辑。 测试环境一键灵活切换,测试生产环境用例同源。 测试结果实时一体化呈现,用例脚本即测即改。 接口覆盖率自动反馈,接口健康度实时呈现。
为项目各个角色设置不同操作权限,包括项目基本信息的编辑和归档、角色及权限的设置和成员设置,还可以根据需要自定义角色类型并授权。 修改系统角色的权限 单击项目名称,进入目标项目,单击“项目设置 > 权限管理 > 权限”,进入权限管理页面。 选择左侧角色名称,在右侧单击“编辑”可为角色勾选设置不同操作权限。
进入接口自动化用例编辑的“脚本”页签,单击“循环”。 设置循环次数。 循环中可添加URL请求、判断、分组、等待、测试关键字。 判断 如果需要根据前序测试步骤的结果决定后续需要执行的测试步骤,可使用“if判断”。 判断设置方式如下: 进入接口自动化用例编辑的“脚本”页签,单击“if判断”。
API设计、开发、测试等关键开发流程一站式协同。 API托管、运维、变现等运营流程一体化协同。 API全流程数据自动同步。 灵活API设计方式 支持表单可视化编辑设计API。 支持Swagger编辑器原生开发者体验。 API设计和API文档 100% 一致,所写即所得,以使用者视角定义API。 API设计规范检查 基
进入接口自动化用例编辑的“脚本”页签,单击“循环”。 设置循环次数。 循环中可添加URL请求、判断、分组、等待、测试关键字。 判断 如果需要根据前序测试步骤的结果决定后续需要执行的测试步骤,可使用“if判断”。 判断设置方式如下: 进入接口自动化用例编辑的“脚本”页签,单击“if判断”。
API设计、开发、测试等关键开发流程一站式协同。 API托管、运维、变现等运营流程一体化协同。 API全流程数据自动同步。 灵活API设计方式 支持表单可视化编辑设计API。 支持Swagger编辑器原生开发者体验。 API设计和API文档 100% 一致,所写即所得,以使用者视角定义API。 API设计规范检查 基
产品功能 表1 CodeArts API服务功能概览 功能名称 功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。
在“成员”页面,将鼠标移动到项目成员角色类型旁,单击编辑按钮。 弹出“更改成员的项目角色为”对话框,根据实际情况为成员设置项目角色,单击“确定”完成角色设置。 (可选)批量修改项目成员角色。 在“成员”页面,勾选目标成员,然后单击“编辑项目角色”。 在弹出的窗口中修改角色类型。 单击
产品功能 表1 CodeArts API服务功能概览 功能名称 功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。
在“成员”页面,将鼠标移动到项目成员角色类型旁,单击编辑按钮。 弹出“更改成员的项目角色为”对话框,根据实际情况为成员设置项目角色,单击“确定”完成角色设置。 (可选)批量修改项目成员角色。 在“成员”页面,勾选目标成员,然后单击“编辑项目角色”。 在弹出的窗口中修改角色类型。 单击
Mock规则设计 Mock语法说明 API测试 API测试与API设计同源,设计示例一键导入测试步骤。 测试步骤免编辑一键导入,测试数据契约化自动同步。 测试参数、断言、数据提取可视化编辑。 测试环境一键灵活切换,测试生产环境用例同源。 测试结果实时一体化呈现,用例脚本即测即改。 接口覆盖率自动反馈,接口健康度实时呈现。
Y Y 编辑 编辑关键字 Y Y Y Y N Y Y Y Y N N 删除 删除关键字 Y Y Y Y N Y Y Y Y N N 全局变量 创建 创建全局变量 Y Y Y Y N Y Y Y Y N N 查看 查看全局变量 Y Y Y Y Y Y Y Y Y Y Y 编辑 编辑全局变量
Y Y 编辑 编辑关键字 Y Y Y Y N Y Y Y Y N N 删除 删除关键字 Y Y Y Y N Y Y Y Y N N 全局变量 创建 创建全局变量 Y Y Y Y N Y Y Y Y N N 查看 查看全局变量 Y Y Y Y Y Y Y Y Y Y Y 编辑 编辑全局变量