如何使用Typescript和Node生成RESTAPI文档？

我可以用它来创建RESTAPI文档吗

---

欢迎就如何重用TypeScript类型来生成RESTAPI文档提出任何建议（使用Next.js）

如果您真正想要的是用TypeScript描述您的API，并从中获得一个招摇过市的/OpenAPI定义，请尝试

它不仅可以生成RESTAPI文档，还可以让您使用符合RESTAPI定义的随机数据（用于测试客户端）和数据模型验证器（用于测试服务器）运行模拟服务器

项目自述中的示例：

从“@airtasker/spot”导入{api、端点、请求、响应、主体}；
@原料药({
名称：“我的API”
})
类Api{}
@端点({
方法：“张贴”，
路径：“/users”
})
类CreateUser{
@请求
请求（@body-body:CreateUserRequest）{}
@响应（{状态：201}）
响应（@body-body:CreateUserResponse）{}
}
接口CreateUserRequest{
名字：字符串；
lastName:string；
}
接口CreateUserResponse{
名字：字符串；
lastName:string；
角色：字符串；
}

Typedoc将显示您添加的任何JSDoc标记，但对API doc标记没有特殊处理。TypeDoc更侧重于记录内部代码。