检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用CodeArts API快速设计并调试接口 访问CodeArts API产品首页,单击“网页版体验”,首次使用华为云账号登录CodeArts API的用户,系统将默认为该用户新建“示例项目”并进入项目,用户可基于示例接口认识API相关概念并熟悉产品使用方法。 使用API设计 示例项目
审核功能开启后,对于API接口的操作都需要提交审核并通过后才可生效。 查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情。
审核功能开启后,对于API接口的操作都需要提交审核并通过后才可生效。 约束与限制 审核流程结束前,提交审核的API接口将处于锁定状态,不可编辑和删除。 查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。
兼容Postman脚本语法,可以在CodeArts API中直接运行Postman脚本。 Postman中Run collection功能可以通过使用CodeArts API的API测试实现,支持接口的自动化测试,可视化界面灵活编排测试用例顺序,无需修改脚本,实现“零代码”快速生成测试用例,具体API测试操作可参照API测试导读。
导入/导出接口 导入接口 定时导入接口 导出接口 父主题: 导入与导出
一致,所写即所得,以使用者视角定义API。 API设计规范检查 基于华为10年API治理经验,嵌入国内唯一“先进级”评级的API全生命周期管理规范。 支持API规范自动检查、自动纠错,提升API设计质量。 自动化代码和用例生成 API SDK代码和服务框架代码与API设计同源,基于API文档一键生成代码。
浏览器访问 访问CodeArts API产品官网首页,单击“网页版体验”,填写华为云账户密码进行登录,进入CodeArts API首页。 首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。 浏览器扩展
数。 公共参数文档页面可以查看引用当前公共参数的API。 公共请求体 接口的公共请求体,默认请求类型为“application/json”。 支持设计Body体引用,并且在公共请求体的文档页面支持查看引用当前公共请求体的API。 公共示例 接口的公共示例,可在API设计请求体示例
界面会自动跳转到文档页面,展示名称、正文,上方标签页的名称也会更新为Markdown文件名称。 移动Markdown(可选)。 单击并拖拽Markdown到目标目录后释放即可,移动成功后,目录树会自动刷新,Markdown文件的目录也会同步改变。 父主题: API设计
访问客户端 登录使用 单击“登录/注册”,填写华为云账户密码进行登录。 首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。 未登录使用 打开客户端,在登录页面单击“稍后再说”即可开始使用
快速体验CodeArts API 03 使用 CodeArts API从API设计、API实现、API调试、API测试、API管理、API运营等,端到端从源头到资产实现API规范化管理,提升开发者在API全生命周期管理上的效率与体验。 API设计 API设计 API审核 编辑模式与API规范检查 公共模型
一致,所写即所得,以使用者视角定义API。 API设计规范检查 基于华为10年API治理经验,嵌入国内唯一“先进级”评级的API全生命周期管理规范。 支持API规范自动检查、自动纠错,提升API设计质量。 自动化代码和用例生成 API SDK代码和服务框架代码与API设计同源,基于API文档一键生成代码。
式;在左侧编辑正文时,右侧会同步展示编辑内容,便于查看、修改样式等。 编辑完成后,单击右上角“保存”,左侧目录树同步刷新,界面会自动跳转到文档页面,展示名称、正文,上方标签页的名称也会更新为Markdown文件名称。 移动Markdown(可选)。 单击并拖拽Markdown到目
前置脚本、后置脚本功能需要登录后才可继续使用。 登录使用 单击“登录/注册”,填写华为云账户密码进行登录。 首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。 未登录使用 打开客户端,在登录页面单击“
导入通过Postman导出的文件时,接口示例会被同时导入为快捷调试接口,名称和Postman中接口示例名称相同。 单击“导入”,导入成功后可直接单击“发送”进行调试,也可保存为接口。 使用API设计 单击“API设计”模块,可以看到示例项目中已经预设了不同请求的API示例和公共模型。 在“API设计”模块,单击任意接口,如“查询产品列表”。
以快速构造异常场景,提升测试覆盖率。 前后端分离开发:前端开发往往依赖于后端数据接口,在后端接口就绪之前,前端往往很难推进,前端可以通过Mock功能制造场景数据接口来进行开发与调试。 父主题: API Mock
页面或接口级高级Mock页面。 目录级Mock规则管理页面 单击“API设计”,然后单击接口目录右侧的,选择“Mock规则管理”。 进入“Mock规则管理”页面,可以查看当前目录下所有接口和接口对应的Mock规则。 接口级高级Mock页面 单击“API设计”,选择对应的接口。 单
CodeArt API的客户端与Web端差异 CodeArts API的客户端与Web端在主要功能使用上没有明显差异,但在少部分特定场景下,Web端因受限于浏览器的限制,无法支持如设置全局代理、使用快捷键等功能。推荐使用客户端,享受更全面的功能体验。 父主题: 功能相关
开启审核功能后,在项目下API设计中创建、删除、修改API的操作均会被记录为草稿内容,需要通过审核后生效。 关闭审核功能 在“审核设置”页签,单击,弹出“审核设置”对话框。 根据提示输入“CLOSE”后,单击“确定”,关闭审核功能。 关闭审核功能后,在项目下API设计中创建、删除、修改API的操作
开启审核功能后,在项目下API设计中创建、删除、修改API的操作均会被记录为草稿内容,需要通过审核后生效。 关闭审核功能 在“审核设置”页签,单击,弹出“审核设置”对话框。 根据提示输入“CLOSE”后,单击“确定”,关闭审核功能。 关闭审核功能后,在项目下API设计中创建、删除、修改API的操作