从头开始创建一个自动产生文档/类型安全的现代API(6) 创建子路径

2025-02-22

Word count: 499 | Reading time≈ 2 min

创建子路径

上一篇我们创建了 api/节点，这次我们继续创建子节点，通过在Routes路径下创建子目录和文件实现。
首先，添加 app/api/[[...route]]/routes/tasks/tasks.index.ts:

import { createRouter } from "../../lib/create-app";

import * as handlers from "./tasks.handlers";
import * as routes from "./tasks.routes";

const router = createRouter()
  .openapi(routes.list, handlers.list);

export default router;

这个文件作为索引文件，链接了handler和router两个文件，我们来创建它们。

创建 app/api/[[...route]]/routes/tasks/tasks.routes.ts:

import { createRoute, z } from "@hono/zod-openapi";
import * as HttpStatusCodes from "stoker/http-status-codes";
import { jsonContent } from "stoker/openapi/helpers";

export const list = createRoute({
  tags: ["Tasks"],
  path: "/tasks",
  method: "get",
  responses: {
    [HttpStatusCodes.OK]: jsonContent(
      z.array(z.object({
        name: z.string(),
        done: z.boolean(),
      })),
      "List of tasks",
    ),
  },
});

export type ListRoute = typeof list;

这个文件定义了task子路径下的路径及描述。

创建 app/api/[[...route]]/routes/tasks/tasks.handlers.ts:

import { AppRouteHandler } from "@/utility/types";
import type { ListRoute } from "./tasks.routes";

export const list: AppRouteHandler<ListRoute> = (c) => {
  return c.json([
    { name: "Learn OpenAPI", done: false },
    { name: "Learn Hono", done: true },
  ]);
};

同时，用到了一个新的类型，修改 utility/types.ts：

import { OpenAPIHono,RouteHandler,RouteConfig } from "@hono/zod-openapi";
import { PinoLogger } from "hono-pino";

export interface AppBindings {
    Variables: {
        logger: PinoLogger;
    }
};

export type AppOpenAPI = OpenAPIHono<AppBindings>;

export type AppRouteHandler<R extends RouteConfig> = RouteHandler<R, AppBindings>;