prisma-docs-generator 配置全解：output 与 includeRelationFields 参数完整指南

prisma-docs-generator 配置全解output 与 includeRelationFields 参数完整指南【免费下载链接】prisma-docs-generatorPrisma generator for automatically generating documentation reference from the Prisma schema.项目地址: https://gitcode.com/gh_mirrors/pr/prisma-docs-generatorprisma-docs-generator 是一款 Prisma schema 文档生成器它能从schema.prisma自动产出可交互的 HTML API 参考文档。本文带你一次性搞懂它最核心的两个配置参数——output与includeRelationFields并附上预览命令 serve 的正确用法10 分钟完成整套配置。 快速上手3 步接入 prisma-docs-generator先安装并声明生成器再触发prisma generate文档就会自动出炉npm install -D prisma-docs-generator在schema.prisma中添加generator docs { provider node node_modules/prisma-docs-generator }然后执行npx prisma generate最后在本地预览npx prisma-docs-generator serve浏览器打开终端提示的地址默认http://localhost:5858即可看到按模型组织的完整文档左侧目录、右侧字段与操作列表一应俱全。 output 参数详解自定义文档输出路径output决定生成的index.html和样式文件写到哪里。场景写法不配置使用默认输出生成器 manifest 中的./docs自定义output ../../docsgenerator docs { provider node node_modules/prisma-docs-generator output ../../docs }两个注意点相对路径是相对于schema.prisma所在目录解析的跨目录时记得用../。生成逻辑位于 src/index.ts它会先mkdir目标目录再写入index.html与styles/main.css若输出目录不可写会直接报错No output was specified。 includeRelationFields 参数详解关系字段一键开关模型间的关联字段如User.posts、Post.user会让文档变得更长。includeRelationFields用于控制是否在文档中展示这些关系字段默认值为true。generator docs { provider node node_modules/prisma-docs-generator includeRelationFields false }⚠️隐藏的坑参数解析逻辑在 src/index.ts 中为「只有严格等于字符串false时才隐藏」即includeRelationFields true或乱填的值都会按 true 处理。想关掉就老老实实写false。实现原理很简单src/generator/transformDMMF.ts 在转换 DMMF 数据时会过滤掉所有带relationName的字段。相关行为可在测试 src/tests/transformDMMF.test.ts 中对照验证。️ 用 serve 命令本地预览文档生成完成后内置 CLI 可以直接把静态文档跑起来源码见 src/cli.ts读取 schema 中该生成器的output路径作为站点根目录支持--port/-p换端口默认端口5858若 schema 里没写outputserve 会直接提示无法解析输出路径。npx prisma-docs-generator serve -p 8080❓ 常见配置问题清单改了 schema 文档没更新文档是prisma generate时生成的每次改完记得重新执行。文档太乱、关联字段太多加includeRelationFields false模型间引用字段会从字段列表中隐藏。想集成到项目 docs 目录用output ../../docs之类的路径指过去再配静态服务器或 CI 产物即可。字段注释不显示schema 里用///写文档注释示例见 prisma/schema.prisma生成后会在文档中展示。 小结prisma-docs-generator 的全部配置其实就两个旋钮output管「文档去哪儿」includeRelationFields管「关系字段显不显」。配合serve命令从 Prisma schema 到可分享的 API 参考文档只需一条命令。【免费下载链接】prisma-docs-generatorPrisma generator for automatically generating documentation reference from the Prisma schema.项目地址: https://gitcode.com/gh_mirrors/pr/prisma-docs-generator创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考