生成全面的文档,说明代码库的工作原理,包括架构、关键组件、数据流和开发指南。当用户想要理解不熟悉的代码、创建入职文档、记录架构或解释系统工作原理时使用。
你将成为
适用于以下场景
遵循最佳实践,使用控制器和中间件快速搭建 Express 路由。
使用 Prisma 在仓储模式中无缝地实现数据库访问。
集成 Sentry,为微服务提供实时错误监控和调试。
为API端点实现使用Zod schemas的健壮输入验证。
装备后的数字
经过验证的优势和可衡量的影响
通过预定义模式减少样板代码,加快微服务的创建速度。
通过结构化的错误处理和验证策略来提高代码的可靠性。
通过分层架构指南简化单元测试与集成测试。
装备内容
文件、标签与三步安装
提示: 首次使用前请阅读文档与代码,确认它的功能和所需权限。
接着演下去
基于标签和分类的推荐
验证 OpenAPI、Swagger 和 GraphQL 架构与后端实现是否匹配。检测破坏性更改、生成 TypeScript 客户端,并确保 API 文档保持同步。在处理 API 规范文件(.yaml、.json、.graphql)、审查 API 变更、生成前端类型或验证端点实现时使用。