在Next.js中集成swagger文档 - 程序设计实验室
💡
原文中文，约3200字，阅读约需8分钟。
📝
内容提要
Next.js 不直接支持 Swagger，需要通过 API Routes 结合使用。可以选择自动生成或手动编写 OpenAPI 文档，使用工具如 next-swagger-doc 生成文档，但需手动定义接口 schema，过程较繁琐。总体而言，Next.js 更适合前端开发，API 编写不太理想。
🎯
关键要点
- Next.js 不直接支持 Swagger，需要通过 API Routes 结合使用。
- 可以选择自动生成或手动编写 OpenAPI 文档。
- 使用工具 next-swagger-doc 生成文档，但需手动定义接口 schema，过程繁琐。
- Next.js 更适合前端开发，API 编写不太理想。
- 自动生成工具可以根据 TypeScript 类型生成 Swagger 文档。
- 手动生成需要使用 swagger-jsdoc 等工具，从 API route 上生成 OpenAPI spec。
- 两种方法都不是很完美，Next.js 偏向前端开发，编写大量 API 不合适。
🏷️
标签
➡️
