检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API网关注册 CodeArts API支持将状态为“已测完”或“已发布”的API注册到APIG网关实例,用户需要登录APIG实例,将已注册的API发布,API即可在APIG中正式生效。 API从注册到发布的管理流程如下: 准备工作 在使用API网关注册功能前,用户需要先购买AP
API网关注册 CodeArts API支持将状态为“已测完”或“已发布”的API注册到APIG网关实例,用户需要登录APIG实例,将已注册的API发布,API即可在APIG中正式生效。 API从注册到发布的管理流程如下: 准备工作 在使用API网关注册功能前,用户需要先购买AP
I规范设计定义,请参照设置API设计规范。 编辑模式 规范性检查 设置API设计规范 单击项目名称,进入目标项目,单击“项目设置 > 设计规范设置”,进入“设计规范设置”页面。 新增设计规范 在“设计规范”页签,单击“新增设计规范”,填写规范名称,选择是否继承已创建的规范、填写规范描述。
I规范设计定义,请参照设置API设计规范。 编辑模式 规范性检查 设置API设计规范 单击项目名称,进入目标项目,单击“项目设置 > 设计规范设置”,进入“设计规范设置”页面。 新增设计规范 在“设计规范”页签,单击“新增设计规范”,填写规范名称,选择是否继承已创建的规范、填写规范描述。
DELETE(删除):用于删除服务端的指定资源。 OPTIONS(选项):用于获取服务器支持的http方法和资源的相关信息。可用于客户端与服务端之间的握手过程,了解服务器所支持的方法和功能。 HEAD(请求头):与GET类似,但只返回响应头部,不返回实体内容,用于获取资源的元信息,如:文件大小、修改日期等。
DELETE(删除):用于删除服务端的指定资源。 OPTIONS(选项):用于获取服务器支持的http方法和资源的相关信息。可用于客户端与服务端之间的握手过程,了解服务器所支持的方法和功能。 HEAD(请求头):与GET类似,但只返回响应头部,不返回实体内容,用于获取资源的元信息,如:文件大小、修改日期等。
API设计 项目概况 API设计 接口审核 编辑模式与API规范检查 公共模型 Markdown设计 API调试 脚本能力
Markdown设计 新建Markdown,可通过以下三种方式完成。 方法一:单击目录树搜索框右侧的,在弹出的下拉框中,选择“新建Markdown”。 方法二:在目录树中选择一个目录,单击右侧图标,在弹出的下拉框中,选择“新建Markdown”。 进入“新建标签页”,在该标签页可
API设计 项目概况 API设计 接口审核 编辑模式与API规范检查 公共模型 Markdown设计 API调试 脚本能力
Markdown设计 新建Markdown,可通过以下三种方式完成。 方法一:单击目录树搜索框右侧的,在弹出的下拉框中,选择“新建Markdown”。 方法二:在目录树中选择一个目录,单击右侧图标,在弹出的下拉框中,选择“新建Markdown”。 进入“新建标签页”,在该标签页可
raw:在文本框中输入文本内容,在“raw”选项旁边可以下拉选择输入文本内容格式,如Text和Json。 请求参数的默认值均来自API设计的样例值。 在API调试页面修改请求参数,不能保存至API设计与API文档中。 返回响应 显示响应是否成功、响应时间、状态码、请求方式以及响应体信息和响应头信息。 保存为用例
raw:在文本框中输入文本内容,在“raw”选项旁边可以下拉选择输入文本内容格式,如Text和Json。 请求参数的默认值均来自API设计的样例值。 在API调试页面修改请求参数,不能保存至API设计与API文档中。 返回响应 显示响应是否成功、响应时间、状态码、请求方式以及响应体信息和响应头信息。 保存为用例
码。 API测试与API设计同源,设计示例一键导入测试步骤。 丰富的可扩展插件 运行时插件实现API一键托管,保障API高安全、高可用、高并发调用。 API一键注册到网关 实现API一键发布到运行时插件APIG(云原生网关),确保API开发态与运行态的一致性。
本可以实现在快捷调试或接口请求时添加动态行为。脚本执行流程如图: CodeArts API兼容Postman脚本语法,可以将Postman脚本迁移到CodeArts API中使用。 CodeArts API脚本能力仅限于快捷调试、接口调试、接口调试用例。 接口的前置脚本与后置脚本支持配置多个,并按照配置顺序执行。
Mock规则设计 配置请求规则 请求Mock服务时,系统会根据规则中配置的参数匹配,只有规则下所有参数满足匹配条件时,才可匹配到整个规则。 请求参数,支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。
Mock规则设计 配置请求规则 请求Mock服务时,系统会根据规则中配置的参数匹配,只有规则下所有参数满足匹配条件时,才可匹配到整个规则。 请求参数,支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。
本可以实现在快捷调试或接口请求时添加动态行为。脚本执行流程如图: CodeArts API兼容Postman脚本语法,可以将Postman脚本迁移到CodeArts API中使用。 CodeArts API脚本能力仅限于快捷调试、接口调试、接口调试用例。 接口的前置脚本与后置脚本支持配置多个,并按照配置顺序执行。
n”结构。 在设计API的响应体时,可以直接引用已设计好的公共响应。 公共响应文档页面可以查看引用当前公共响应的API。 公共参数 接口的公共请求参数,参数位置可选“query”参数、“path”参数、“header”参数。 在设计API的请求参数时,可以引用已设计好的公共参数。
n”结构。 在设计API的响应体时,可以直接引用已设计好的公共响应。 公共响应文档页面可以查看引用当前公共响应的API。 公共参数 接口的公共请求参数,参数位置可选“query”参数、“path”参数、“header”参数。 在设计API的请求参数时,可以引用已设计好的公共参数。
项目概况 进入CodeArts API目标项目后,默认进入项目概况页面,可查看项目下数据统计及API集合情况。 父主题: API设计