检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
单击,弹出“接口审核”页面,默认可查看项目中所有“待审核”状态的API接口列表。
接口审核 审核设置 提交审核 接口审核 父主题: API设计
单击,弹出“接口审核”页面,默认可查看项目中所有“待审核”状态的API接口列表。
导入/导出接口 导入接口 定时导入接口 导出接口 父主题: 导入与导出
导入接口 功能说明 CodeArts API支持导入以下API数据格式文件,方便数据迁移。
接口审核 审核设置 提交审核 接口审核 父主题: API设计
单击“生成代码”下拉框,获取接口代码,具体操作请参照API开发。 父主题: 功能相关
导出接口 在接口目录或已设计好的接口功能目录中,可以导出OpenAPI 3.0、Swagger 2.0版本格式的接口文件,且文件格式支持Yaml、Json。 单击接口目录或接口功能目录名称右侧,选择“导出”。 在弹出的“导出”窗口中,选择需要导出的数据格式及接口,单击“导出”。
定时导入接口 CodeArts API支持执行定时任务来导入API接口。 单击“项目设置 > 导入数据”,默认进入“定时导入”页签。 单击“新建”,弹出“新增定时任务”窗口。 配置任务参数,参数配置请参考下表。
推送接口 CodeArts API支持将设计完成的接口推送至第三方URL。 单击“项目设置 > 导出数据”,默认进入“第三方推送”页签。 单击“新建”,弹出“新增同步任务”窗口。 配置任务参数,参数配置请参考下表。
弹出“变更对比”页面,可查看API接口变更前后的对比详情。 其他项目参与者有权限同步查看项目下任意API接口的变更详情。 提交审核 在API接口的“文档”页面单击“提交审核”,弹出“提交审核”页面,可查看接口变更前后的对比详情。
导出接口 在接口目录或已设计好的接口功能目录中,可以导出OpenAPI 3.0、Swagger 2.0版本格式的接口文件,且文件格式支持Yaml、Json、Html。 单击接口目录或接口功能目录名称右侧,选择“导出”。
导入接口 功能说明 CodeArts API支持导入以下API数据格式文件,方便数据迁移。
导入/导出接口 导入接口 定时导入接口 导出接口 推送接口 父主题: 导入与导出
关闭审核功能后,在项目下API设计中创建、删除、修改API的操作将立即生效,不再需要审核,同时清空未生效的API修改记录和未审批通过的提交审核记录。 父主题: 接口审核
单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情。 其他项目参与者有权限同步查看项目下任意API接口的变更详情。
定时导入接口 CodeArts API支持执行定时任务来导入API接口。 单击“项目设置 > 导入数据”,默认进入“定时导入”页签。 单击“新建”,弹出“新增定时任务”窗口。 配置任务参数,参数配置请参考下表。
关闭审核功能后,在项目下API设计中创建、删除、修改API的操作将立即生效,不再需要审核,同时清空未生效的API修改记录和未审批通过的提交审核记录。 父主题: 接口审核
请求方式 定义接口的请求方式,制定了客户端对服务端资源操作的方法,在API设计过程中,需要根据业务和操作类型选择合适的请求方式。 GET(获取):用于获取指定资源,使用查询参数传递参数,适用于读取资源和查询数据。 POST(提交):用于提交数据。
高级Mock CodeArts API提供高级Mock功能,可以查询和定义调试接口的Mock规则。 单击接口的“高级Mock”页签,可以查看该接口对应的Mock规则。 单击“查询产品列表”,弹出“编辑Mock规则”页面。