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

V2EX = way to explore

V2EX 是一个关于分享和探索的地方

For Existing Member Sign In

This topic created in 364 days ago, the information mentioned may be changed or developed.

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

node.js

接口文档

生成工具

29 replies • 2025-08-12 11:45:03 +08:00

wuxilaoshiren

Apr 29, 2025

有没有正经开发 nodejs 后端的老哥帮忙看看

jikun

Apr 29, 2025

不用 swagger 吗？

wu67

Apr 29, 2025

后端就跟前端对接而已啊, 前端能看不懂你的代码?
你把关键方法的注释按 jsdoc 写好就行了, 直接把项目 pull 权限开给前端组.

Zhuzhuchenyan

Apr 29, 2025

经历过的正经的大项目基本最后都上了 Nest.js

小项目的话，最近在做 CF Worker 相关，CF 强推 https://github.com/cloudflare/chanfana ，可以根据 Zod 生成 OpenAPI 文档

XCFOX

Apr 29, 2025

推荐 orpc( https://orpc.unnoq.com/ ) ：你只管写代码，orpc 会直接根据 zod 、valibot 类型生成 OpenAPI 文档。
更推荐 GQLoom ( https://gqloom.dev/ ) : 你只管写代码，GQLoom 会直接根据 zod 类型、valibot 类型、drizzle 表定义、Prisma 模型定义生成 GraphQL 文档。

oppy

Apr 29, 2025

让 AI 给你生成 swagger

nomagick

Apr 29, 2025

我自己写了一套..

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

恕我直言现在 Node.js 生态里面，我不是针对谁，全部都是🗑️

mumbler

Apr 29, 2025

cursor 打开项目，ctrl+i, 帮我生成接口文档

shakaraka

PRO

Apr 29, 2025

参考 elysiajs ，配合 drizzle 的话，可以达到全链路强类型。

https://elysiajs.com

momo2789

Apr 29, 2025

https://github.com/readmeio/swagger-inline

jake4545

Apr 29, 2025

让 AI review 代码，顺便生成 markdown 格式的接口文档

weipt

Apr 29, 2025

我很好奇，有公司使用 nodejs 开发后端？

cunoe

Apr 29, 2025 via Android

让 ai 写 openapi 文档

jamesjammy061

Apr 29, 2025

感觉 immich 做的就挺好

WasteNya

Apr 30, 2025 via Android

直接用 swagger / openapi spec 啊

christmasin2015

Apr 30, 2025

前后端都是 js/ts 了，你们应该单独开一个项目把所有接口约定在 interface 里。

asen001

Apr 30, 2025

如果用 fastify ，可以用 json schema ，接口文档，基本的入参校验都有了。json schema 用 typebox + ai 写，还算方便。

公司只能接受 java ，接的私活用 node

capric

Apr 30, 2025

遵循 openapi 规范，直接通过接口拿到全局视图

loveshuyuan

Apr 30, 2025

hono openapi

llej

Apr 30, 2025

都用 node 了，其实可以不生成文档，直接生成 npm lib 给前端用

AndyChina

Apr 30, 2025

没人用 trpc 吗, 前端直接强类型校验, 都不用看文档的

kenshinhu

Apr 30, 2025

我早期的是使用 apidoc 直接在代码上注释转成 apidoc

Hanser002

Apr 30, 2025

之前 nodejs 后端的时候用 kubb 基于 swagger 生成对应的 useQuery 。

借楼问下，如果后端不是 nodejs 有没有合适的方案

ghos

Apr 30, 2025

@asen001 node 有什么快速开发的框架吗，目前是 java 技术栈
@llej 也是需要手工写 axios 请求的吧，如果想要连这步都省了感觉 openapi 生成比较好

AllenTsui

Apr 30, 2025

让 cursor 给你写文档

kid1412621

May 1, 2025 via iPhone

@XCFOX #5 原来是作者啊😂

llej

May 1, 2025

@ghos 你可以试试我这个项目，虽然不支持 openapi ，但是前后端都不用手写请求，https://github.com/2234839/TsFullStack

humbass

May 30, 2025

我们一直使用 markdown 手写，req, res 分别一个表格参数，一个 json 示例。
现在有 AI 就更方便，给几个示例，后面的都可以自动生成

zhennann

Aug 12, 2025

为什么要排除 nest.js 呢？是否是因为 nest.js 提供的装饰器并不好用，声明一些 Openapi 相关的元信息太繁琐。
可以试试 VonaJS ，装饰器非常简洁，而且把参数验证与 Openapi 统一在一起了，不再是两张皮（不再写两遍）。同时 Openapi 中的描述信息还支持国际化能力。可以参见：[Entity]( https://vona.js.org/zh/guide/essentials/api/entity.html)和[Controller]( https://vona.js.org/zh/guide/essentials/api/controller.html)