API开发的必备神器:华为云CodeArts API实用体验入门篇

举报
华为云PaaS服务小智 发表于 2024/05/08 15:11:12 2024/05/08
【摘要】 今天我想给大家推荐一款API全生命周期研发与管理工具:华为云CodeArts API。作为互联网软件的开发者,在软件研发的过程中,API的开发、调试、测试是必不可少的。之前我使用的是Postman这类工具来辅助开发, Postman在接口调试方面确实有一定的优势。然而,随着项目复杂度的提升和团队协作需求的演变,我们开始寻求在API设计的标准化、接口编排测试、以及Mock服务的高效集成等方面更...

今天我想给大家推荐一款API全生命周期研发与管理工具:华为云CodeArts API

作为互联网软件的开发者,在软件研发的过程中,API的开发、调试、测试是必不可少的。之前我使用的是Postman这类工具来辅助开发, Postman在接口调试方面确实有一定的优势。然而,随着项目复杂度的提升和团队协作需求的演变,我们开始寻求在API设计的标准化、接口编排测试、以及Mock服务的高效集成等方面更加全面且高效的解决方案。

直到同事向我推荐了华为云CodeArts API,我们亲身体验了华为产品,解决上述需求方面的出色表现让我欣喜,所以我迫不及待地想将其分享给大家,希望能帮助更多的开发者解决开发中遇到的问题。

PostmanCollections全量数据迁移

在试用CodeArts API以后,我遇到的第一个问题就是如何把Postman上的数据迁移到新工具上,当然可以将Collection一个一个的导出,并导入到新工具上,但是由于我之前的接口太多了,显然一个个操作是一件很困难的事情。

CodeArts API特别强化了对Postman用户迁移数据的支持,现在可直接导入Postman全量的Collections文件与Environments环境变量,这意味着数据迁移将会变得非常便捷。

首先从PostmanSettings -> Data页面,将CollectionsEnvironments数据集导出,此时可以得到一个ZIP的压缩包,其中包含了多个CollectionEnvironment文件。


我们可以选择将此压缩文件导入到CodeArts APIAPI设计或快捷调试。


    选择要导入的ZIP文件压缩包,并可以选择接口和环境变量。


导入成功后发现,原来在Postman上同一个接口的快捷调试将会被合并,变成一个API下面的调试用例,API设计完全与我的项目一致,以后再需要调试,就可以直接使用API设计的调试能力了。


并且在Postman中,为API调试写的脚本也都同步迁移过来了,而且可以继续运行,CodeArts API的接口调试脚本完美兼容了Postman

 

可视化API设计与Swagger原生编辑

由于我之前使用的是Postman的离线版本,主要将Postman作为接口的调试工具,没有使用过Postman做接口设计。这次在试用CodeArts API过程中,发现它在API设计上的精彩表现,所以我也想尝试下API设计。

CodeArts API与传统的API设计工具有所区别,我们项目组都是将API编写为SwaggerYaml格式文件,并提交到代码仓中,然后通过maven插件去生成接口与变量的java代码。但是对于项目组的新员工并不是很友好,并且在排查接口文件内容的时候,也经常需要花费很多精力。

CodeArts API可以支持可视化的API设计,这对于菜鸟是非常友好的。


与此同时,如果是像我一样有经验的开发者,也可以使用Swagger原生编辑器去设计API,并且CodeArts API提供了设计规范检查功能,可以在Swagger编辑器中查看是否编写错误。


并且CodeArts API支持将接口文档以yaml的格式导出,直接将其复制到代码中提交即可,这极大的提升了设计效率,所以以后我也会把CodeArts API作为我的软件设计工具首选。


 目前我也是刚刚开始使用华为云的CodeArts API工具,除了以上分享的功能外,CodeArts API还提供了API MockAPI测试等能力,深度使用以后,我会持续跟大家分享我的实用体验。

 

想了解更多的功能,请保存产品的官网链接:https://developer.huaweicloud.com/develop/codeartsapi.html

【版权声明】本文为华为云社区用户原创内容,转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息, 否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。