检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
2):校验JSONSchema。 实用工具 postman-collection( v3.4.0):Postman Collection库。 cheerio(v0.22.0):jQuery的子集。 lodash (v4.17.11):JS实用工具库。 uuid :生成UUID。 moment(v2
2):校验JSONSchema。 实用工具 postman-collection( v3.4.0):Postman Collection库。 cheerio(v0.22.0):jQuery的子集。 lodash (v4.17.11):JS实用工具库。 uuid :生成UUID。 moment(v2
API文档页面展示了定义好的API信息,包括API路径、请求参数、请求体、返回响应等信息,可通过右侧文档目录切换至对应模块进行查看。在文档展示页面,可以修改API状态。单击“运行”,可切换到调试页面进行API调试。 父主题: API设计
API文档页面展示了定义好的API信息,包括API路径、请求参数、请求体、返回响应等信息,可通过右侧文档目录切换至对应模块进行查看。在文档展示页面,可以修改API状态。单击“运行”,可切换到调试页面进行API调试。 父主题: API设计
查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情。 其他项目参与者有权限同步查看项目下任意API接口的变更详情。 提交审核
查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情。 其他项目参与者有权限同步查看项目下任意API接口的变更详情。 提交审核
API管理痛点 传统的API全生命周期管理方案,研发团队通常会使用多种工具管理API: Swagger:设计与管理API文档 Postman:API调试工具 Mockjs:Mock API数据 JMeter:API自动化测试工具 因此,在传统的研发流程中,开发者常常面对以下繁琐的协作场景:
API管理痛点 传统的API全生命周期管理方案,研发团队通常会使用多种工具管理API: Swagger:设计与管理API文档 Postman:API调试工具 Mockjs:Mock API数据 JMeter:API自动化测试工具 因此,在传统的研发流程中,开发者常常面对以下繁琐的协作场景:
API提供API设计版本管理功能,可在不同版本之间进行快速切换,也可对不同版本API接口进行直接对比。 创建版本 单击项目名称,进入目标项目,单击“项目设置 > 版本管理”,进入“版本管理”页面。 单击“新增版本”,填写版本号和描述。 单击“确定”。 单击项目名称下“基线”旁的下拉框,可快速切换版本(支持根据版本名快速搜索),并对版本进行编辑。
行快速切换,也可对不同版本API接口进行直接对比。 创建版本 单击项目名称,进入目标项目,单击“项目设置 > 版本管理”,进入“版本管理”页面。 单击“新增版本”,填写版本号和描述,默认勾选“同步创建测试版本”。 单击“确定”。 单击项目名称下“基线”旁的下拉框,可快速切换版本(
API调试 完成API设计之后,在API文档页面单击“运行”会自动切换到API调试页面,也可以单击“调试”页签切换到API调试页面,本节介绍调试页面相关信息配置。 由于浏览器限制,使用CodeArts API的Web版本进行接口调试,需要先安装浏览器扩展,浏览器扩展请查看浏览器扩展。
API调试 完成API设计之后,在API文档页面单击“运行”会自动切换到API调试页面,也可以单击“调试”页签切换到API调试页面,本节介绍调试页面相关信息配置。 由于浏览器限制,使用CodeArts API的Web版本进行接口调试,需要先安装浏览器扩展,浏览器扩展请查看浏览器扩展。
要在预发环境验证,不同环境对应不同的前置URL和接口参数值,为了方便快速切换运行环境,快速修改前置URL等参数,CodeArts API提供了环境管理功能。 环境参数入口 进入目标项目后,在右上角提供快速切换环境下拉框,提供快速搜索功能。 单击下拉框右侧,即可进入“环境参数”页面。
应用场景 CodeArts API面向开发者提供API全生命周期管理的最佳实践。 CodeArts API既可以帮助个人开发者一站式管理运营自己的API,摆脱工具、环境的束缚,快速实现API资产变现;也可以帮助企业规范化API流程,端到端提升设计、开发、测试、运维、运营等各组织的配合效率。
根据需要选择语言、生成范围(包括“仅当前接口及关联模型”和“整个项目”),单击“生成”将生成的代码存储到本地,开发者可以将代码复制到本地的研发工具(如IntelliJ IDEA)。
根据需要选择语言、生成范围(包括“仅当前接口及关联模型”和“整个项目”),单击“生成”将生成的代码存储到本地,开发者可以将代码复制到本地的研发工具(如IntelliJ IDEA)。
计费说明 CodeArts API属于开发者生态工具,使用软件开发生产线CodeArts的套餐计费规则,用户可以登录CodeArts控制台购买套餐。 CodeArts API将“快捷调试”,“API设计”,“API Mock”,“API发布”等特性免费开放给所有开发者,用户仅需要
CodeArts API面向开发者提供API全生命周期管理的最佳实践。 CodeArts API既可以帮助个人开发者一站式管理运营自己的API,摆脱工具、环境的束缚,快速实现API资产变现;也可以帮助企业规范化API流程,端到端提升设计、开发、测试、运维、运营等各组织的配合效率。 图1 CodeArts
操作步骤 单击,弹出“接口审核”页面,默认可查看项目中所有“待审核”状态的API接口列表。 单击操作列的,弹出“审核详情”页面,可查看API接口变更前后的对比详情。 填写“审核意见”,单击“通过”或“拒绝”,完成API接口的审核。 对于已提交审核的API接口,提交人员可通过进入“接口审核”页面进行撤回审核的操作。
操作步骤 单击,弹出“接口审核”页面,默认可查看项目中所有“待审核”状态的API接口列表。 单击操作列的,弹出“审核详情”页面,可查看API接口变更前后的对比详情。 填写“审核意见”,单击“通过”或“拒绝”,完成API接口的审核。 对于已提交审核的API接口,提交人员可通过进入“接口审核”页面进行撤回审核的操作。