这是一个创建于 47 天前的主题，其中的信息可能已经有所发展或是发生改变。
各位在公司里的 nodejs 后端项目，怎么生成的接口文档？排除 nest.js 和 jsdoc 的方式。
 |
1
wuxilaoshiren OP 有没有正经开发 nodejs 后端的老哥帮忙看看
|
 |
2
GuoJikun 47 天前
不用 swagger 吗？
|
 |
3
wu67 47 天前
后端就跟前端对接而已啊, 前端能看不懂你的代码?
你把关键方法的注释按 jsdoc 写好就行了, 直接把项目 pull 权限开给前端组. |
 |
4
Zhuzhuchenyan 47 天前
经历过的正经的大项目基本最后都上了 Nest.js
小项目的话，最近在做 CF Worker 相关，CF 强推 https://github.com/cloudflare/chanfana ，可以根据 Zod 生成 OpenAPI 文档 |
 |
5
XCFOX 47 天前
推荐 orpc( https://orpc.unnoq.com/ ) ：你只管写代码，orpc 会直接根据 zod 、valibot 类型生成 OpenAPI 文档。
更推荐 GQLoom ( https://gqloom.dev/ ) : 你只管写代码，GQLoom 会直接根据 zod 类型、valibot 类型、drizzle 表定义 、Prisma 模型定义生成 GraphQL 文档。 |
 |
6
oppy 47 天前
让 AI 给你生成 swagger
|
 |
7
nomagick 47 天前
我自己写了一套..
完全不用 Nest.js 没有 Zod 依赖.. 恕我直言现在 Node.js 生态里面，我不是针对谁，全部都是🗑️ |
 |
8
mumbler 47 天前
cursor 打开项目，ctrl+i, 帮我生成接口文档
|
 |
9
wunonglin 47 天前
|
 |
11
jake4545 47 天前
让 AI review 代码，顺便生成 markdown 格式的接口文档
|
 |
12
weipt 47 天前
我很好奇，有公司使用 nodejs 开发后端？
|
 |
13
cunoe 47 天前 via Android
让 ai 写 openapi 文档
|
 |
14
jamesjammy061 46 天前
感觉 immich 做的就挺好
|
 |
15
WasteNya 46 天前 via Android
直接用 swagger / openapi spec 啊
|
 |
16
christmasin2015 46 天前
前后端都是 js/ts 了，你们应该单独开一个项目把所有接口约定在 interface 里。
|
 |
17
asen001 46 天前
如果用 fastify ，可以用 json schema ，接口文档，基本的入参校验都有了。json schema 用 typebox + ai 写，还算方便。
公司只能接受 java ，接的私活用 node  |
 |
18
capric 46 天前
遵循 openapi 规范，直接通过接口拿到全局视图
|
 |
19
loveshuyuan 46 天前
hono openapi
|
 |
20
llej 46 天前
都用 node 了，其实可以不生成文档，直接生成 npm lib 给前端用
|
 |
21
AndyChina 46 天前
没人用 trpc 吗, 前端直接强类型校验, 都不用看文档的
|
 |
22
kenshinhu 46 天前
我早期的是使用 apidoc 直接在代码上注释转成 apidoc
|
 |
23
Hanser002 46 天前
之前 nodejs 后端的时候用 kubb 基于 swagger 生成对应的 useQuery 。
借楼问下，如果后端不是 nodejs 有没有合适的方案 |
 |
24
ghos 46 天前
|
 |
25
AllenTsui 46 天前
让 cursor 给你写文档
|
 |
26
kid1412621 45 天前 via iPhone
@XCFOX #5 原来是作者啊😂
|
|
27
llej 45 天前
@ghos 你可以试试我这个项目，虽然不支持 openapi ，但是前后端都不用手写请求，https://github.com/2234839/TsFullStack
|
 |
28
humbass 16 天前
我们一直使用 markdown 手写，req, res 分别一个表格参数，一个 json 示例。
现在有 AI 就更方便，给几个示例，后面的都可以自动生成 |
Select Language