分享
你的 AI 智能体正确吗?API 开发中 10+ 个智能体的启示与反思
输入“/”快速插入内容
你的 AI 智能体正确吗?API 开发中 10+ 个智能体的启示与反思
飞书用户2749
2024年9月24日修改
尽管,如过去构建 AutoDev 的 AutoCRUD、精准测试功能一样,我们有意去构建一个
完全自动化的 API 开发智能体
。但是依旧的,我们会遇到一些问题:
•
API 设计是需要人类参与的,因为它需要考虑到业务逻辑、数据结构等等。
•
API 文档是结合上下文与业务背景的。
•
一次生成大量 API 代码存在大量的安全风险。
•
AI 生成大量的代码,需要人类参与进行代码审查。
•
大量的测试可以提升 API 的质量,但是测试的覆盖率、测试的准确性等等,都是需要人类参与的。
•
……
也因此,在当前阶段,我们预期的一个智能体变为了 10+ 个智能体,以降低人的心智负担。也因此,我们开始思考三个问题:
•
过去的流程中,AI 可以参与到哪些环节?
•
如何在 AI 自动化与人类参与之间取得平衡?
•
如何确保生成的 API 和文档符合高质量标准?
也由此,这有了这篇文章的内容。
回顾:经典 API 开发流程
在构建 API 时,通常我们会有两个阶段:商业战略阶段与技术实现阶段。在商业战略阶段,我们会考虑到 API 的业务价值、API 的商业模式等等。在技术实现阶段,我们会考虑到 API 的设计、API 的文档、API 的测试等等。
在技术实现阶段,我们会有以下几个步骤:
•
设计阶段
:
◦
API 上下游的契约设计
:确定 API 的输入输出格式,使用开放 API 规范(如Swagger/OpenAPI)定义契约,确保接口清晰一致。
◦
API 文档编写
:编写易于理解的文档,涵盖使用示例、错误码及认证信息,使开发者快速上手。
•
实现阶段
:
◦
编码实现 API
:根据设计文档进行编码,遵循编码规范与最佳实践,注重错误处理和日志记录。
◦
开发者手动测试
:初步测试 API 的基本功能,确保接口能正常响应请求并返回正确的数据。
◦
API 单元测试
:编写单元测试验证 API 各组件的正确性,确保代码在不同情况下的稳定性与可靠性。
•
集成与联调阶段
:
◦
应用间集成
:确保 API 能与其他系统或服务有效集成,进行端到端测试验证数据流和交互正常。
◦
前后端联调
:开发团队与前端工程师合作,进行接口联调,确保前端能正确调用 API 并处理响应数据。
•
测试阶段
:
◦
API 功能测试
:验证 API 每个功能是否按照设计要求正常工作,确保接口逻辑正确。
◦
API 性能测试
:测试 API 在高负载下的响应时间与稳定性,包括压力测试与负载测试,确保满足业务需求。
◦
API 安全测试
:进行安全性审查与测试,检测潜在安全漏洞,如认证、授权、数据加密等,确保API不易受到攻击。
•
发布阶段
:
◦
API 发布与文档更新
:在测试通过后,准备 API 的生产环境部署,更新 API 文档,确保相关方获取最新使用信息。
◦
监控与反馈
:上线后持续监控 API 使用情况与性能表现,通过用户反馈和日志分析不断迭代与优化 API。
这是一个非常完美的 API 开发流程,但是在实际开发中,我们会遇到大量的问题。毕竟,白天你和各个上下游的人员沟通完,只剩下下班前的半小时,又或者是 晚上的时间来写代码。在你加班加点干完活后,你的代码写完了,但是文档没写完,测试没写完,甚至是你的代码写完了,又或者你的代码不符合规范。
那 AI 可以吗?
试验:API 开发的 10+ 个本地智能体