检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
公共模型 公共模型提供API设计时所需公共数据的定义,在设计API的Body请求体或返回响应时,如果需要使用某种数据模型、公共响应等,可直接引用对应的公共模型,单击“公共模型”搜索框右侧,新建不同类型公共模型,CodeArts API提供以下7种公共模型定义:数据模型、公共响应、公共参数
公共模型 公共模型提供API设计时所需公共数据的定义,在设计API的Body请求体或返回响应时,如果需要使用某种数据模型、公共响应等,可直接引用对应的公共模型,单击“公共模型”搜索框右侧,新建不同类型公共模型,CodeArts API提供以下7种公共模型定义:数据模型、公共响应、公共参数
提交审核 审核功能开启后,对于API接口的操作都需要提交审核并通过后才可生效。 查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情
提交审核 审核功能开启后,对于API接口的操作都需要提交审核并通过后才可生效。 约束与限制 审核流程结束前,提交审核的API接口将处于锁定状态,不可编辑和删除。 查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API
API设计 API(应用程序编程接口)设计是API全生命周期的第一步,其含义是通过规定接口的路径、所属目录、Tag、请求参数、请求体等来定义接口,从而帮助开发人员在沟通中对某一接口有着同样、确定的定义。 新建API 进入CodeArts API目标项目后,单击左侧搜索框旁边的,选择下拉选项中的
API设计 API(应用程序编程接口)设计是API全生命周期的第一步,其含义是通过规定接口的路径、所属目录、Tag、请求参数、请求体等来定义接口,从而帮助开发人员在沟通中对某一接口有着同样、确定的定义。 新建API 进入CodeArts API目标项目后,单击左侧搜索框旁边的,选择下拉选项中的
快捷调试的接口代码怎么获取? 操作步骤 在接口的快捷调试页面单击,选择“保存为接口”。 在“保存为接口”页面输入接口名称,选择接口目录,单击“确定”,保存接口。 单击“API设计”,选择保存的接口,默认进入接口的文档页签。 单击“生成代码”下拉框,获取接口代码,具体操作请参照API
功能总览 功能总览 全部 API设计 API Mock API测试 API管理运维 API设计 API设计和API文档100%一致,所写即所得,以使用者视角定义API。 一键新建API、Markdown,Swagger标准文件一键导入。 Swagger 原生&结构表单API可视化编辑
功能总览 功能总览 全部 API设计 API Mock API测试 API管理运维 API设计 API设计和API文档100%一致,所写即所得,以使用者视角定义API。 一键新建API、Markdown,Swagger标准文件一键导入。 Swagger 原生&结构表单API可视化编辑
API开发 CodeArts API支持生成接口请求代码和业务代码,缩短前后端开发时长,规范代码结构。 基于接口定义,CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块,接口文档界面右侧,即可看到“生成代码”的入口。 生成接口请求代码 单击“生成代码
API开发 CodeArts API支持生成接口请求代码和业务代码,缩短前后端开发时长,规范代码结构。 基于接口定义,CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块,接口文档界面右侧,即可看到“生成代码”的入口。 生成接口请求代码 单击“生成代码
API调试 完成API设计之后,在API文档页面单击“运行”会自动切换到API调试页面,也可以单击“调试”页签切换到API调试页面,本节介绍调试页面相关信息配置。 约束与限制 由于浏览器限制,使用CodeArts API的Web版本进行接口调试,需要先安装浏览器扩展,浏览器扩展请查看浏览器扩展
API调试 完成API设计之后,在API文档页面单击“运行”会自动切换到API调试页面,也可以单击“调试”页签切换到API调试页面,本节介绍调试页面相关信息配置。 由于浏览器限制,使用CodeArts API的Web版本进行接口调试,需要先安装浏览器扩展,浏览器扩展请查看浏览器扩展
导入接口 功能说明 CodeArts API支持导入以下API数据格式文件,方便数据迁移。 Swagger Postman(支持Collections和Environment数据集ZIP包) Jmeter Swagger URL 手动导入 通过主页面的“更多功能”选项或单击左上角搜索框旁边的
导入接口 功能说明 CodeArts API支持导入以下API数据格式文件,方便数据迁移。 Swagger Postman(支持Collections和Environment数据集ZIP包) Jmeter Swagger URL 约束与限制 导入文件时,一个文件导入后,将会视为一个根目录
Markdown设计 约束与限制 Markdown文件只能在同一根目录下进行移动。 处于编辑页面的Markdown文件不能移动。 创建Markdown文件 新建Markdown,可通过以下三种方式完成。 方法一:单击目录树搜索框右侧的,在弹出的下拉框中,选择“新建Markdown”
编辑模式与API规范检查 CodeArts API在API设计界面提供代码编辑模式进行API设计,可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能,可以形成统一的设计规范,避免API设计不一致,提高API设计质量。API
编辑模式与API规范检查 CodeArts API在API设计界面提供代码编辑模式进行API设计,可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能,可以形成统一的设计规范,避免API设计不一致,提高API设计质量。API
Markdown设计 新建Markdown,可通过以下三种方式完成。 方法一:单击目录树搜索框右侧的,在弹出的下拉框中,选择“新建Markdown”。 方法二:在目录树中选择一个目录,单击右侧图标,在弹出的下拉框中,选择“新建Markdown”。 进入“新建标签页”,在该标签页可以编辑
IAM账号进入CodeArts API首页报错 IAM账号首次进入CodeArts API首页报错,需要给IAM账号进行授权。 CodeArts API支持的系统权限如下: DevCloud Console ReadOnlyAccess:软件开发生产线控制台只读权限,授权后可正常使用