【DTSE Tech Talk 精选问答】NO.62丨华为云CodeArts API，为开发者打造全新的API研发体验

在数字化时代，企业如何做好API全生命周期管理？本期直播将为您分享华为云API治理经验，介绍华为云API全生命周期一体化协作平台CodeArts API。通过维护API各开发阶段数据高度一致，实现从API设计、开发、测试到部署和运维的一站式体验，让API管理化繁为简。为企业提供全方位的解决方案，助力企业在数字化浪潮中破浪前行。
直播链接：https://bbs.huaweicloud.cn/live/DTT_live/202407171630.html

Q：CodeArts API提供哪些用户体验设计最佳实践？

A:

1、轻量化工具：支持网页与客户端。
2、简化用户操作并兼顾原生编辑：提供可视化编辑与swagger原生编辑两种API设计方式；
3、API设计同步：打通API全生命周期，与华为云很多工具关联，实现数据同步；
4、了解用户：深入了解目标用户群体的背景、‌需求和习惯，‌以用户为中心进行设计。‌

Q：API测试阶段，CodeArts API提供哪些模拟和虚拟化工具？

A:在API测试阶段，用户可以从接口用例、接口等导入测试步骤，CodeArts API提供API Mock功能，可以替代真实业务服务场景，完成测试需求。

Q：华为云API治理框架包括哪些关键组件？CodeArts API平台支持哪些类型的API测试？

A:华为API全生命周期解决方案包括：CodeArts API，CodeArts TestPlan，CodeArts PerfTest，APIG，APIE等。CodeArts API支持接口自动化测试和测试套件，其余测试能力均由CodeArts TestPlan，CodeArts PerfTest提供，详情请在官网搜索CodeArts TestPlan，CodeArts PerfTest两款产品，查看详情，欢迎体验。

Q：CodeArts API如何确保API的安全性，防止未授权访问和数据泄露？

A:华为API全生命周期管理方案是由华为云的多个工具组成的，API安全性主要由网关APIG来保证，详情请在华为云官网搜索APIG，欢迎体验。

Q：如何监控和优化API的性能，以确保高可用性和响应时间？

A:CodeArts API通过API网关确保API的安全性，主要包含如下安全能力：

1、可信接入：支持HTTPs，支持mTLS认证，保证网络传输安全。API流量控制，按APP、API、IP等多维度的流控策略保护系统。
2、访问认证：提供AK+SK、Token方式进行应用的认证，只允许授权的访问。IP地址黑白名单，拒绝恶意访问。
3、日志审计：支持LTS日志仪表盘分析，通过业务操作、异常调用的分析可以为追查和恢复提供客观依据。
4、转发层：提供负载均衡、自动熔断等能力，支持对后端服务的证书校验，支持安全通道访问后端服务。

Q：CodeArts API提供了哪些关键特性来帮助开发者和企业简化API的生命周期管理？

A:API设计、API测试、APIMock、API注册网关、API发布。

Q：华为云API治理经验具体包括哪些方面？

A:流程： API First纳入流程，明确各阶段、各角色的关键职责； 工具： API全生命周期工具，帮助优化API研发与管理体系； 方法：发布API First军规、API全生命周期规范等； 组织：成立API管理组织； 赋能：API全生命周期课程； 管理：API开放度、可用性、规范性、一致性、易用性等纳入门禁考核指标。

Q：为什么在数字化时代，企业需要重视API的全生命周期管理？

A:

1、API经济趋势：API是重要的变现途径，并且其商业价值越来越重要；
2、API安全威胁：API开放就会遭到攻击，给企业带来损失，需要重视安全问题；
3、企业研发效率：传统的研发模式效率低，出错的成本高，api first理念帮助企业提升研发管理效率。

Q：网关到底是用来干啥的吗

A:华为云API网关（APIG）是为企业和开发者提供的高性能、高可用、高安全的云原生网关服务，融合安全、负载均衡、流量入口治理、微服务流量治理、运维等多项能力，帮助企业轻松实现API安全开放、API高并发调用和入口流量、微服务流量精细化治理，简单、快速、低成本、低风险地实现内部系统集成和业务能力开放变现。

Q：CodeArts API平台是否支持API的自动化文档生成和API门户的创建？平台如何查看API成本和计费？

A:API门户对接正在进行中，后续提供对应的能力；CodeArts API主要聚焦在API开发态，包括api规划、设计、审核、开发、测试等流程。

Q：CodeArts API平台是否支持对API进行性能压力测试？怎么管理API的依赖和冲突？

A:CodeArts API不支持性能测试，华为云性能测试 CodeArts PerfTest是一项为应用接口、链路提供性能测试的云服务，支持HTTP/HTTPS/TCP/UDP等协议。PerfTest丰富的测试模型定义能力可以真实还原应用大规模业务访问场景，帮助用户提前识别应用性能问题，后续CodeArts API将与PerfTest对接。 CodeArts API支持版本控制，用户可以根据需要创建，各版本之间的API冲突，提供了版本对比功能，在代码层面，需要开发者自己保证。

Q：CodeArts API平台是否支持对API进行流量控制和限流？API的退役和归档是如何管理的？

A:API流控可用过华为云APIG云原生网关完成；CodeArts API支持版本管理，支持版本间的同一个API对比。

Q：能否融入人工智能？如何保证API的兼容性？

A:目前还没有做大模型的相关能力，大模型是工具软件的发展趋势，后续将有相应的功能设计。

Q：如何在API全生命周期管理中实现需求的快速响应？CodeArts API平台支持API的性能监控吗？

A:CodeArts API是API研发管理工具，目前不提供需求管理相关功能；华为云性能测试 CodeArts PerfTest是一项为应用接口、链路提供性能测试的云服务，支持HTTP/HTTPS/TCP/UDP等协议。PerfTest丰富的测试模型定义能力可以真实还原应用大规模业务访问场景，帮助用户提前识别应用性能问题；后续CodeArts API将与PerfTest对接。

Q：对于新手开发者来说，如何快速上手使用 CodeARTS API 进行研发？

A:CodeArts API提供了示例项目，并且所有的示例项目都提供了API mock，方便新手快速上手使用，新用户首次登录即自动创建示例项目。

Q：如何利用 CodeARTS API 提高团队的协作和效率？

A:

1、添加用户时，可定义各用户的角色；
2、采用API first研发模式，设计优先，后续其他流程根据设计进行；
3、减少手工修改设计以外的其他环节数据，尽量使用API设计文档同步。

Q：部署到网关后，如果发现有问题，是否能一键回退

A:

1、添加用户时，可定义各用户的角色；
2、采用API first研发模式，设计优先，后续其他流程根据设计进行；
3、减少手工修改设计以外的其他环节数据，尽量使用API设计文档同步。

Q：部署到网关后，如果发现有问题，是否能一键回退

A:CodeArts API支持将开发完成的API注册到API网关，但并未完成API发布，此时发现API问题可以修改完在CodeArts API中重新注册，再根据需要在API网关中完成上线操作。

Q：在实际的项目中，如何更好地设计和规划 API 接口？

A:

在规划和设计API时需要综合考虑各方面情况，如下内容可参考：
1、采用5W2H方法进行API规划与定义；
2、定义云服务的API使用场景，例如API能力、API组合、SDK等；
3、对标友商，持续优化云服务API的体验与竞争力；
4、定义目标开发者、商业目标、服务级别、资源对象、约束与限制等。

Q：CodeArts API可以提供哪些API文档设计方式？

A:CodeArts API提供Swagger原生&可视化结构表单两种API设计编辑模式，满足不同技术水平开发者的API设计需求，设计完成后即可自动生成API文档。

Q：CodeArts API平台后期迁移和扩容方便吗？需要客户额外购买服务吗？

A:CodeArts API提供标准swagger文件的导入和导出能力，并支持市面上主流的API开发文件格式导入，方便客户迁移数据。 CodeArts API的大部分能力都是免费提供的，如果特性需要使用华为云资源，则需要单独开通。 CodeArts API属于CodeArts软件开发生产线的一部分，如果想使用更多软件研发工具，则需要开通CodeArts套餐，如果用户只使用CodeArts的部分服务，也可以单独购买CodeArts某个服务的套餐，目前CodeArts的8个服务都可以单独购买套餐。

Q：感觉整体流程还是比较复杂，比较多的，针对比较小的团队和小的项目，是否有更简单灵活的使用方式？

A:用户可以选择只使用部分能力，甚至可以将CodeArts API作为API调试工具使用。

Q：在 API 研发过程中，有哪些常见的挑战和解决方案？

A:1、API一致性问题：主要是api全生命周期的数据不一致，我们提倡使用api first模式，即设计先行，其余api全生命周期流程都要围绕设计进行，通过设计文档驱动整个流程； 2、API规范性问题：例如，架构师们在api设计时，如果不遵循一定的规范，可能导致设计的api不一致，比如参数命名、鉴权等，需要项目组内统一API规范。 3、API管理混乱：主要是前期都是代码生成的api文档，可能有不及时更新，后续又缺少管理，可能导致企业不清楚自己发布在现网的api数量，需要按照一定的规范整改，并统计api，后续采用api first模式，管理好api。

Q：如何使用 CodeArts API 进行 API 研发？有哪些常用的功能和工具？

A:可以使用CodeArts API的api设计生成代码能力，支持生成多种主流编程语言和开发框架的客户端及服务端代码，将生成的代码copy到IDE中。

Q：如果这个文档要导出给其他部门，这个是否能支持导出成word

A:目前CodeArts API只支持导出接口的yaml及json文件格式，暂不支持导出word。

Q：CodeArts API适合微服务架构吗？能否实现自动化的API测试？

A:CodeArts API是API研发管理工具，与微服务架构没有直接关系，可以使用；目前支持接口自动化测试功能，更多的测试能力由CodeArts TestPlan和CodeArts PerfTest提供。

Q：API 的全生命周期管理如何平衡灵活性与规范性？

A:规范是可以分级别的，在API管理过程中可以按照产品的不同成熟度，提出合适的规范遵从度要求，进行灵活配置。

Q：CodeArts API的定价策略是怎样的？

A:CodeArts API属于开发者生态工具，目前将大部分功能免费提供给华为开发者，但是如果需要用到华为云资源，则需要单独购买，例如：apig，华为云执行机。用户使用CodeArts API工具，只需要开通CodeArts体验版套餐，即可提供50人的使用，如果在同一个账号下需要更多的用户去使用，则需要购买CodeArts的高阶套餐。

Q：企业做数字化转型，实施API全生命周期管理时，应该关注哪些关键环节？

A:实施API全生命周期管理除了理解和遵循API管理的各阶段实施要求，还应重点关注相应的组织、规范、流程、工具建设，这些是保障API全生命周期管理能真正落地的重要条件。

Q：CodeArts API支持哪些编程语言？

A:支持主流的编程语言，欢迎体验产品。

Q：CodeArts API平台支持哪些API设计标准和规范？

A:目前只支持华为云API设计规范，详情请登录产品，在项目设置->设计规范设置中查看。

Q：API治理过程中，如何做好API的安全和隐私保护？

A:API安全和隐私在API规范和设计时就要考虑，上线后再去治理就比较晚了，在进行API设计和开发时可参考OWASP常见安全攻击和防护方法。采用API网关对API请求进行安全管控是当前业界的最佳实践，同时对敏感信息加密保护和掩码处理，在隐私保护方面还要参考所在国的隐私保护要求。

Q：CodeArts API相比其他API管理平台的优势在哪？

A:

1、CodeArts API拥有API设计规范检查功能。
2、完全遵从openapi的设计规范；
3、对接了华为云其他的云服务，打通API全生命周期，在用户使用体验上更好。

Q：spring现在已经有swagger能自动生成api了，那华为云的这个CodeArts有啥用？能代替掉swagger吗

A:CodeArts API提供了API设计的可视化编辑和swagger原生编辑两种方式，较传统的swagger编辑方式更容易上手，并且可以通过api设计生成代码，方便开发者开发代码，同时CodeArts API提供了API Mock、API测试等能力。

Q：如何利用CodeArts API平台优化API的部署流程？如何利用CodeArts API平台优化API的部署流程？

A:CodeArts API支持将开发完成的API一键注册到API网关，只需要简单的配置好目标APIG实例，就可以将API直接注册到API网关，再根据需要在APIG中完成API的发布即可；微服务的部署请使用CodeArts软件开发生产线。

Q：api设计后又会改动，最后还要改文档很麻烦。华为云怎么解决这个问题？

A:API设计和发布需要遵循API生命周期管理流程和规范，不允许随便改动和变更。如果要对已经基线的API进行变更，需要相应层级的API管理团队进行评审把关，并通过工具自动化检查（如规范性、兼容性等）。对于API变更后的文档等配套资源，应用CodeArts API平台可以实现同步自动生成，不需要人工多处维护。

Q：CodeArts API平台在API测试阶段有哪些优势？

A:集成了自动化测试功能，包含一系列测试请求、测试检查点和测试逻辑，完成对接口的功能测试，实现了从 API 设计、调试到测试的全程一体化数据同步管理。 支持将接口或接口用例直接导入测试，并利用可视化界面灵活编排测试用例顺序，无需修改脚本，即可轻松实现“零代码”快速生成测试用例。同时支持将测试用例组合编排后生成测试套件，配置执行策略，省去人工看护的成本，避免了访问高峰。 此外还提供关键字库能力，将接口关键字、组合关键字、系统关键字三种类型的测试关键字进行统一管理。解决在设计测试用例时，重复编写相同的前置步骤或者测试逻辑并且难以维护的难题，帮助开发者复用这些测试步骤。

Q：CodeArts API平台支持开发团队的协作吗？最多支持多少人同时使用？

A:CodeArts API团队协作以api first为设计理念。免费版本最多支持50人使用，即开通CodeArts体验版套餐。如果单个账号想让超过50个用户使用，则需要开通CodeArts的高阶套餐，目前是按照人数收费的。

Q：如何利用CodeArts API来助力企业进行数字化转型？

A:

API是数字化转型的核心，通过CodeArts API对企业API全生命周期进行管理，有助于实现：
1、提高企业内部协作效率：加速业务功能解耦、架构解耦、团队解耦；
2、缩短TTM：提升微服务重用率，降低业务创新复杂性；
3、解放商业模式：资产共享，降低企业间合作门槛；
4、灵活组合：通过API组装应用，灵活衔接各种工具和服务，改善客户体验。

Q：CodeArts API是否支持API的版本控制，避免不同版本间的冲突？

A:CodeArts API支持版本控制，用户可以根据需要创建，各版本之间的API冲突，提供了版本对比功能，在代码层面的冲突，需要开发者自己保证。

Q：华为云在api治理过程中是怎么确保API设计阶段与后续阶段的数据一致性的呢？

A:

1、设计与开发的一致性，可以通过两种方法来做到。第一种，可以使用CodeArts API的api设计生成代码能力，将生成的代码copy到IDE中，统一提交。第二种，也是华为很多研发体系在用的，将设计的yaml文档上传到代码仓，开发人员下载后，通过mvn等插件去生成代码，开发人员不允许在IDE中提交API设计yaml文件，这种方法可以自由定制生成规则，比较灵活；
2、设计同步测试，将API设计或者调试用例作为测试步骤，导入到测试用例中，避免手工编辑；
3、后续其他流程均通过设计的yaml文档生成，避免人工编辑，需要做的是数据使用工具同步。

Q：请问API全生命周期管理是如何与DevOps实践相结合的，起到了什么作用？

A:软件开发生产线（CodeArts）是面向开发者提供的一站式云端平台，即开即用，随时随地在云端交付软件全生命周期，覆盖需求下发、代码提交、代码检查、代码编译、验证、部署、发布，打通软件交付的完整路径，提供软件研发流程的端到端支持。CodeArts API属于软件开发生产线工具链的一部分，补齐了CodeArts的API设计能力。API全生命周期管理也是DevOps实践的一个关键组成部分，通过提供标准化、自动化的API创建、测试、部署和管理流程，支持DevOps中的快速迭代、高质量软件交付和持续改进的目标。

Q：产品特性与应用场景：请问CodeArts API的具体产品特性，以及它在不同行业或场景中的应用情况

A:CodeArts API是一款API研发、管理工具，与行业和场景无关，但目前只支持Restful协议，目前不支持其他协议，后续将支持更多的协议。

Q：CodeArts API平台在实际应用中有没有成功案例？

A:CodeArts API是华为云API First专项孵化外溢的工具，已经经过华为云多年的实践检验，产品与2024年4月9号正式发布，已经有多家企业使用，并且后续产品将会打造更多的实用性功能，华为云API全生命周期解决方案将为开发者带来全新的研发体验。

想要了解更多CodeArts API相关知识，欢迎观看DTSE Tech Talk 系列技术直播