nodejs 后端,怎么比较好的生成接口文档?(排除 nest.js)

9 天前
 wuxilaoshiren

各位在公司里的 nodejs 后端项目,怎么生成的接口文档?排除 nest.js 和 jsdoc 的方式。

2694 次点击
所在节点    Node.js
27 条回复
wuxilaoshiren
9 天前
有没有正经开发 nodejs 后端的老哥帮忙看看
GuoJikun
9 天前
不用 swagger 吗?
wu67
8 天前
后端就跟前端对接而已啊, 前端能看不懂你的代码?
你把关键方法的注释按 jsdoc 写好就行了, 直接把项目 pull 权限开给前端组.
Zhuzhuchenyan
8 天前
经历过的正经的大项目基本最后都上了 Nest.js

小项目的话,最近在做 CF Worker 相关,CF 强推 https://github.com/cloudflare/chanfana ,可以根据 Zod 生成 OpenAPI 文档
XCFOX
8 天前
推荐 orpc( https://orpc.unnoq.com/ ) :你只管写代码,orpc 会直接根据 zod 、valibot 类型生成 OpenAPI 文档。
更推荐 GQLoom ( https://gqloom.dev/ ) : 你只管写代码,GQLoom 会直接根据 zod 类型、valibot 类型、drizzle 表定义 、Prisma 模型定义生成 GraphQL 文档。
oppy
8 天前
让 AI 给你生成 swagger
nomagick
8 天前
我自己写了一套..

完全不用 Nest.js
没有 Zod 依赖..

恕我直言现在 Node.js 生态里面,我不是针对谁,全部都是🗑️
mumbler
8 天前
cursor 打开项目,ctrl+i, 帮我生成接口文档
wunonglin
8 天前
参考 elysiajs ,配合 drizzle 的话,可以达到全链路强类型。

https://elysiajs.com
momo2789
8 天前
jake4545
8 天前
让 AI review 代码,顺便生成 markdown 格式的接口文档
weipt
8 天前
我很好奇,有公司使用 nodejs 开发后端?
cunoe
8 天前
让 ai 写 openapi 文档
jamesjammy061
8 天前
感觉 immich 做的就挺好
WasteNya
8 天前
直接用 swagger / openapi spec 啊
christmasin2015
8 天前
前后端都是 js/ts 了,你们应该单独开一个项目把所有接口约定在 interface 里。
asen001
8 天前
如果用 fastify ,可以用 json schema ,接口文档,基本的入参校验都有了。json schema 用 typebox + ai 写,还算方便。

公司只能接受 java ,接的私活用 node
capric
8 天前
遵循 openapi 规范,直接通过接口拿到全局视图
loveshuyuan
8 天前
hono openapi
llej
8 天前
都用 node 了,其实可以不生成文档,直接生成 npm lib 给前端用

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://yangjunhui.monster/t/1128871

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX