检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API属于开发者生态工具,使用软件开发生产线CodeArts的套餐计费规则,用户可以登录CodeArts控制台购买套餐。 CodeArts API将“快捷调试”,“API设计”,“API Mock”,“API发布”等特性免费开放给所有开发者,用户仅需要开通“CodeArts体验版”套餐,即可免费使用CodeArts
示例项目中已经预设了不同请求的API示例和公共模型。单击任意接口,如“查询产品列表”。 默认进入“文档”页签,可通过右侧文档目录切换页面。 单击“设计”页签可以进入API设计页面,详细操作可参照API设计章节。 单击“调试”页签进入调试页面,详细操作可参照示例接口调试。 示例接口调试 打开“MockURL”开关。
使用API设计 单击“API设计”模块,可以看到示例项目中已经预设了不同请求的API示例和公共模型。 在“API设计”模块,单击任意接口,如“查询产品列表”。 默认进入“文档”页签,可通过右侧文档目录切换页面。 单击“设计”页签可以进入API设计页面,操作可参照API设计章节。 单
导出接口 在接口目录或已设计好的接口功能目录中,可以导出OpenAPI 3.0、Swagger 2.0版本格式的接口文件,且文件格式支持Yaml、Json、Html。 单击接口目录或接口功能目录名称右侧,选择“导出”。 在弹出的“导出”窗口中,选择需要导出的数据格式及接口,单击“导出”。
功能总览 全部 API设计 API Mock API测试 API管理运维 API设计 API设计和API文档100%一致,所写即所得,以使用者视角定义API。 一键新建API、Markdown,Swagger标准文件一键导入。 Swagger 原生&结构表单API可视化编辑,专业
API既可以帮助个人开发者一站式管理运营自己的API,摆脱工具、环境的束缚,快速实现API资产变现;也可以帮助企业规范化API流程,端到端提升设计、开发、测试、运维、运营等各组织的配合效率。 图1 CodeArts API使用场景
产品功能 表1 CodeArts API服务功能概览 功能名称 功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。
产品功能 表1 CodeArts API服务功能概览 功能名称 功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。
CodeArts API CodeArts API是面向开发者,提供API设计、API开发、API文档、API调试、 API自动化测试一体化协作平台,通过维护API各开发阶段数据高度一致,支持开发者高效实现API设计、API开发、API测试一站式体验。 产品介绍 查看官网 立即使用 成长地图
API支持生成接口请求代码和业务代码,缩短前后端开发时长,规范代码结构。 基于接口定义,CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块,接口文档界面右侧,即可看到“生成代码”的入口。 生成接口请求代码 单击“生成代码”下拉框,选择“生成接口请求代码”,弹出“生成接口请求代码”对话框。
功能总览 全部 API设计 API Mock API测试 API管理运维 API设计 API设计和API文档100%一致,所写即所得,以使用者视角定义API。 一键新建API、Markdown,Swagger标准文件一键导入。 Swagger 原生&结构表单API可视化编辑,专业
API既可以帮助个人开发者一站式管理运营自己的API,摆脱工具、环境的束缚,快速实现API资产变现;也可以帮助企业规范化API流程,端到端提升设计、开发、测试、运维、运营等各组织的配合效率。 图1 CodeArts API使用场景
API支持生成接口请求代码和业务代码,缩短前后端开发时长,规范代码结构。 基于接口定义,CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块,接口文档界面右侧,即可看到“生成代码”的入口。 生成接口请求代码 单击“生成代码”下拉框,选择“生成接口请求代码”,弹出“生成接口请求代码”对话框。
从接口/接口用例导入 用户可以将API设计的数据导入测试步骤,主要有两个来源:“从【接口用例】导入(推荐)”和“从【接口】导入”。 从【接口用例】导入(推荐) 在弹出的“从【接口用例】导入(推荐)”对话框上,选择需要导入的接口,即“API设计”中接口的调试用例,参考保存为用例。 单击“导入”,完成测试步骤添加。
从接口/接口用例导入 用户可以将API设计的数据导入测试步骤,主要有两个来源:“从【接口用例】导入(推荐)”和“从【接口】导入”。 从【接口用例】导入(推荐) 在弹出的“从【接口用例】导入(推荐)”对话框上,选择需要导入的接口,即“API设计”中接口的调试用例,参考保存为用例。 单击“导入”,完成测试步骤添加。
02:34 介绍CodeArts API 操作指导 CodeArts API 介绍如何创建API设计及两种设计编辑模式 03:20 创建API设计 CodeArts API 介绍如何设置API设计规范 01:33 API规范性检查 CodeArts API 教你如何利用Mock功能及调试API
API的控制台创建新的项目。 登录CodeArts API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。 项目描述 否 项目描述,限制1024个字符。 单击“确定”,完成项目创建。
API的控制台创建新的项目。 登录CodeArts API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。 项目描述 否 项目描述,限制1024个字符。 单击“确定”,完成项目创建。
API Mock 背景介绍 Mock规则管理 Mock规则设计 Mock语法说明 设置Mock
API Mock 背景介绍 Mock规则管理 Mock规则设计 Mock语法说明 设置Mock