typescript - 如何使用 Typescript 和 Node 生成 REST API 文档？

Question

我可以用https://github.com/TypeStrong/typedoc创建 REST API 文档，如 https://apidocjs.com/ ?
欢迎任何有关如何重用 TypeScript 类型以生成 REST API 文档的建议(使用 Next.js)

Answer 1

如果您真正想要的是在 TypeScript 中描述您的 API 并从中获得 Swagger/OpenAPI 定义，请尝试 https://github.com/airtasker/spot
IT 不仅会生成 REST API 文档，还会让您使用符合 REST API 定义(用于测试客户端)和数据模型验证器(用于测试服务器)的随机数据运行模拟服务器。
来自项目 README 的示例:

import { api, endpoint, request, response, body } from "@airtasker/spot";

@api({
  name: "My API"
})
class Api {}

@endpoint({
  method: "POST",
  path: "/users"
})
class CreateUser {
  @request
  request(@body body: CreateUserRequest) {}

  @response({ status: 201 })
  response(@body body: CreateUserResponse) {}
}

interface CreateUserRequest {
  firstName: string;
  lastName: string;
}

interface CreateUserResponse {
  firstName: string;
  lastName: string;
  role: string;
}