检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API服务功能概览 功能名称 功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。 API Mock 灵活模拟API调用响应。
API服务功能概览 功能名称 功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。 API Mock 灵活模拟API调用响应。
导入通过Postman导出的文件时,接口示例会被同时导入为快捷调试接口,名称和Postman中接口示例名称相同。 单击“导入”,导入成功后可直接单击“发送”进行调试,也可保存为接口。 使用API设计 单击“API设计”模块,可以看到示例项目中已经预设了不同请求的API示例和公共模型。 在“API设计”模块,单击任意接口,如“查询产品列表”。
定义接口的请求方式,制定了客户端对服务端资源操作的方法,在API设计过程中,需要根据业务和操作类型选择合适的请求方式。 GET(获取):用于获取指定资源,使用查询参数传递参数,适用于读取资源和查询数据。 POST(提交):用于提交数据。POST请求可以传递请求体参数,适用创建新资源、提交表单数据或执行某些操作等场景。
定义接口的请求方式,制定了客户端对服务端资源操作的方法,在API设计过程中,需要根据业务和操作类型选择合适的请求方式。 GET(获取):用于获取指定资源,使用查询参数传递参数,适用于读取资源和查询数据。 POST(提交):用于提交数据。POST请求可以传递请求体参数,适用创建新资源、提交表单数据或执行某些操作等场景。
可以输入请求体中每个参数的类型、名称和值。 application/x-www-form-urlencoded:Content-Type为“application/x-www-form-urlencoded”,可以输入请求体中每个参数的名称和值。 raw:在文本框中输入文本内容,
可以输入请求体中每个参数的类型、名称和值。 application/x-www-form-urlencoded:Content-Type为“application/x-www-form-urlencoded”,可以输入请求体中每个参数的名称和值。 raw:在文本框中输入文本内容,
力。API全生命周期管理也是DevOps实践的一个关键组成部分,通过提供标准化、自动化的API创建、测试、部署和管理流程,支持DevOps中的快速迭代、高质量软件交付和持续改进的目标。了解更多软件开发生产线相关信息,请前往查看更多相关介绍。
Windows X86 新特性: 项目管理支持YApi文件导入;快捷调试模块中,表单支持复制和另存为的便捷操作,URL支持引入环境变量;API设计模块中,接口导出功能支持Swagger2.0和JSON格式。 2024-06-04 2.0.5 Windows X86 新特性: API
单击“导入”。 弹出导入进度对话框,可查看导入进度。 导入完成后,可进入导入项目,查看导入的接口。 当导入请求体和响应体结构为Json格式时,支持JsonSchema和Json标准(双斜杠类型字段注释将被识别为字段描述)格式导入。 父主题: 导入与导出
单击“导入”。 弹出导入进度对话框,可查看导入进度。 导入完成后,可进入导入项目,查看导入的接口。 当导入请求体和响应体结构为Json格式时,支持JsonSchema和Json标准(双斜杠类型字段注释将被识别为字段描述)格式导入。 父主题: 导入与导出
从CodeArts API工具导入API资产时,导入方式会默认为“CodeArts API”。 项目信息 CodeArts API项目名称和ID。 API接口 当导入方式为“CodeArts API”时,支持勾选部分接口导入,如果导入全部接口,则忽略此参数。 表2 资产基本信息 参数名称
从CodeArts API工具导入API资产时,导入方式会默认为“CodeArts API”。 项目信息 CodeArts API项目名称和ID。 API接口 当导入方式为“CodeArts API”时,支持勾选部分接口导入,如果导入全部接口,则忽略此参数。 表2 资产基本信息 参数名称
的对比详情。 填写“变更原因”,单击“提交”,提交API接口进入审核流程。 审核流程结束前,该提交审核的API接口将处于锁定状态,不可编辑和删除。 撤回审核 单击,弹出“接口审核”页面,默认可以查看项目中“待审核”状态的API接口列表。 选择需要撤回的API接口,单击操作栏的,进
的对比详情。 填写“变更原因”,单击“提交”,提交API接口进入审核流程。 审核流程结束前,该提交审核的API接口将处于锁定状态,不可编辑和删除。 撤回审核 单击,弹出“接口审核”页面,默认可以查看项目中“待审核”状态的API接口列表。 选择需要撤回的API接口,单击操作栏的,进
项目名称,限制128个字符。 项目描述 否 项目描述,限制1024个字符。 单击“确定”,完成项目创建。 CodeArts API还支持查看和使用在软件开发生产线CodeArts中创建的IPD项目。 修改项目基本信息 单击项目名称,进入目标项目,单击“项目设置 > 基本信息”,可以修改项目基本信息。
项目名称,限制128个字符。 项目描述 否 项目描述,限制1024个字符。 单击“确定”,完成项目创建。 CodeArts API还支持查看和使用在软件开发生产线CodeArts中创建的IPD项目。 修改项目基本信息 单击项目名称,进入目标项目,单击“项目设置 > 基本信息”,可以修改项目基本信息。
TestPlan对整个项目做整体的测试计划与测试方案,更偏向测试场景使用。 接口自动化测试 接口自动化测试提供了丰富的用户可视化编辑页面,支持测试步骤编排,以及测试步骤的检查点和响应结果参数提取,帮助用户快速生成与API设计相匹配的接口测试用例,可实现“零代码”快速生成测试用例,将测试人员从复杂的工作中释放出来,提升软件接口的测试效率。
TestPlan对整个项目做整体的测试计划与测试方案,更偏向测试场景使用。 接口自动化测试 接口自动化测试提供了丰富的用户可视化编辑页面,支持测试步骤编排,以及测试步骤的检查点和响应结果参数提取,帮助用户快速生成与API设计相匹配的接口测试用例,可实现“零代码”快速生成测试用例,将测试人员从复杂的工作中释放出来,提升软件接口的测试效率。
可输入关键字快捷查找已存在的设计规范。 设计规范定义更新 单击“管理”,可以修改设计规范中启用的设计规则。 单击“编辑”,可以修改设计规范的名称和描述。 设计规范删除 单击“删除”,可以删除设计规范。 父主题: API设计