检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
审核设置 API设计审核为用户提供了一套成熟的审核流程,帮助检查项目中设计的API接口是否符合需求。 角色权限 项目经理和项目创建者有审核设置权限。 开启审核功能 单击“项目设置 > 功能设置”,进入“功能设置”页面。
处于编辑页面的Markdown文件不能移动。 父主题: API设计
审核设置 API设计审核为用户提供了一套成熟的审核流程,帮助检查项目中设计的API接口是否符合需求。 角色权限 项目经理和项目创建者有审核设置权限。 开启审核功能 单击“项目设置 > 功能设置”,进入“功能设置”页面。
单击操作列的,弹出“审核详情”页面,可查看API接口变更前后的对比详情。 填写“审核意见”,单击“通过”或“拒绝”,完成API接口的审核。 对于已提交审核的API接口,提交人员可通过进入“接口审核”页面进行撤回审核的操作。 父主题: 接口审核
单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情。 其他项目参与者有权限同步查看项目下任意API接口的变更详情。
Markdown设计 约束与限制 Markdown文件只能在同一根目录下进行移动。 处于编辑页面的Markdown文件不能移动。 创建Markdown文件 新建Markdown,可通过以下三种方式完成。
单击操作列的,弹出“审核详情”页面,可查看API接口变更前后的对比详情。 填写“审核意见”,单击“通过”或“拒绝”,完成API接口的审核。 对于已提交审核的API接口,提交人员可通过进入“接口审核”页面进行撤回审核的操作。 父主题: 接口审核
在文档展示页面,可以修改API状态。单击“运行”,可切换到调试页面进行API调试。 父主题: API设计
在文档展示页面,可以修改API状态。单击“运行”,可切换到调试页面进行API调试。 父主题: API设计
提交审核 在API接口的“文档”页面单击“提交审核”,弹出“提交审核”页面,可查看接口变更前后的对比详情。 填写“变更原因”,单击“提交”,提交API接口进入审核流程。 撤回审核 单击,弹出“接口审核”页面,默认可以查看项目中“待审核”状态的API接口列表。
项目概况 进入CodeArts API目标项目后,默认进入项目概况页面,可查看项目下数据统计及API集合情况。 父主题: API设计
项目概况 进入CodeArts API目标项目后,默认进入项目概况页面,可查看项目下数据统计及API集合情况。 父主题: API设计
可以在接口的“后置脚本”页面中单击“添加后置操作”,发送接口请求后将自动运行后置脚本。 断言 可以利用后置脚本验证API响应返回结果的正确性。
API调试 完成API设计之后,在API文档页面单击“运行”会自动切换到API调试页面,也可以单击“调试”页签切换到API调试页面,本节介绍调试页面相关信息配置。
API调试 完成API设计之后,在API文档页面单击“运行”会自动切换到API调试页面,也可以单击“调试”页签切换到API调试页面,本节介绍调试页面相关信息配置。
可以在接口的“后置脚本”页面中单击“添加后置操作”,发送接口请求后将自动运行后置脚本。 断言 可以利用后置脚本验证API响应返回结果的正确性。
可以在接口的“前置脚本”页面中单击“添加前置操作 > 自定义脚本”,发送接口请求前将自动运行前置脚本。 打印日志 可以通过“console.log()”将需要的变量打印在控制台,用以查看某个变量的当前值。
可以在接口的“前置脚本”页面中单击“添加前置操作 > 自定义脚本”,发送接口请求前将自动运行前置脚本。 打印日志 可以通过“console.log()”将需要的变量打印在控制台,用以查看某个变量的当前值。
公共参数文档页面可以查看引用当前公共参数的API。 公共请求体 接口的公共请求体,默认请求类型为“application/json”。 支持设计Body体引用,并且在公共请求体的文档页面支持查看引用当前公共请求体的API。
公共参数文档页面可以查看引用当前公共参数的API。 公共请求体 接口的公共请求体,默认请求类型为“application/json”。 支持设计Body体引用,并且在公共请求体的文档页面支持查看引用当前公共请求体的API。