nodejs 后端,怎么比较好的生成接口文档?(排除 nest.js)
各位在公司里的 nodejs 后端项目,怎么生成的接口文档?排除 nest.js 和 jsdoc 的方式。
有没有正经开发 nodejs 后端的老哥帮忙看看
不用 swagger 吗?
后端就跟前端对接而已啊, 前端能看不懂你的代码?
你把关键方法的注释按 jsdoc 写好就行了, 直接把项目 pull 权限开给前端组.
经历过的正经的大项目基本最后都上了 Nest.js
小项目的话,最近在做 CF Worker 相关,CF 强推 github.com/cloudflare/chanfana ,可以根据 Zod 生成 OpenAPI 文档
推荐 orpc( orpc.unnoq.com/ ) :你只管写代码,orpc 会直接根据 zod 、valibot 类型生成 OpenAPI 文档。
更推荐 GQLoom ( gqloom.dev/ ) : 你只管写代码,GQLoom 会直接根据 zod 类型、valibot 类型、drizzle 表定义 、Prisma 模型定义生成 GraphQL 文档。
让 AI 给你生成 swagger
我自己写了一套..
完全不用 Nest.js
没有 Zod 依赖..
恕我直言现在 Node.js 生态里面,我不是针对谁,全部都是🗑️
cursor 打开项目,ctrl+i, 帮我生成接口文档
参考 elysiajs ,配合 drizzle 的话,可以达到全链路强类型。
elysiajs.com
github.com/readmeio/swagger-inline
让 AI review 代码,顺便生成 markdown 格式的接口文档
我很好奇,有公司使用 nodejs 开发后端?
让 ai 写 openapi 文档
感觉 immich 做的就挺好
直接用 swagger / openapi spec 啊
前后端都是 js/ts 了,你们应该单独开一个项目把所有接口约定在 interface 里。
如果用 fastify ,可以用 json schema ,接口文档,基本的入参校验都有了。json schema 用 typebox + ai 写,还算方便。
公司只能接受 java ,接的私活用 node
遵循 openapi 规范,直接通过接口拿到全局视图
hono openapi
都用 node 了,其实可以不生成文档,直接生成 npm lib 给前端用
没人用 trpc 吗, 前端直接强类型校验, 都不用看文档的
我早期的是使用 apidoc 直接在代码上注释转成 apidoc
之前 nodejs 后端的时候用 kubb 基于 swagger 生成对应的 useQuery 。
借楼问下,如果后端不是 nodejs 有没有合适的方案
这个需求可能是 既要又要了, 但是被人问到了, 还是来这里问问. (我给不出建议...) 目前用了阿里云 通用算力型 u1 系列, 2 和 8G, 目前很卡很慢, 没访问 c…
css 已选 tailwind / windicss 。UI 组件库有啥推荐的吗 既然都 tailwind 了,那必须 daisyui 了 很多都用 chakra ui 吧…
公司有个运行在外网的生产环境,是 linux 早期版本,本着只要代码能运行,就没人去动的原则,内核一直比较老。 然后我想加一点小功能,想着现在 clang 那么强大了,跨平台…