ApiEndpointsからからjson schemaへの変換処理を共通化

Author: mpppk

pkgs/docs/docs/07_openapi.md

@@ -0,0 +1,9 @@
+---
+sidebar_position: 7
+---
+
+# OpenAPI
+
+The [OpenAPI](https://swagger.io/specification) Specification (OAS) defines a standard, language-agnostic interface to HTTP APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic.
+
+typed-api-spec provides a way to generate OpenAPI specification from specs written by TypeScript.

pkgs/docs/docs/07_playground.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 7
+sidebar_position: 8
 ---
 
 # Playground

pkgs/typed-api-spec/src/zod/jsonschema.ts …gs/typed-api-spec/src/core/jsonschema.tspkgs/typed-api-spec/src/zod/jsonschema.ts renamed to pkgs/typed-api-spec/src/core/jsonschema.ts pkgs/typed-api-spec/src/zod/jsonschema.ts renamed to pkgs/typed-api-spec/src/core/jsonschema.ts

@@ -1,52 +1,54 @@
 import {
+  AnyApiEndpoint,
+  AnyApiEndpoints,
+  AnyApiResponses,
+  AnyApiSpec,
   apiSpecRequestKeys,
   extractExtraApiSpecProps,
   extractExtraResponseProps,
   JsonSchemaApiEndpoints,
   JsonSchemaApiResponses,
   JsonSchemaApiSpec,
   Method,
-  StatusCode,
-} from "../core";
-import {
-  ZodAnyApiResponses,
-  ZodApiEndpoint,
-  ZodApiEndpoints,
-  ZodApiSpec,
-} from "./index";
-import { createSchema } from "zod-openapi";
+} from "./spec";
+import { StatusCode } from "./hono-types";
 import { JSONSchema7 } from "json-schema";
-import { z } from "zod";
 
-export const toJsonSchemaApiEndpoints = <E extends ZodApiEndpoints>(
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type ToSchema = (schema: any) => JSONSchema7;
+
+export const toJsonSchemaApiEndpoints = <E extends AnyApiEndpoints>(
+  toSchema: ToSchema,
   endpoints: E,
 ): JsonSchemaApiEndpoints => {
   const ret: JsonSchemaApiEndpoints = {};
   for (const path of Object.keys(endpoints)) {
-    ret[path] = toJsonSchemaEndpoint(endpoints[path]);
+    ret[path] = toJsonSchemaEndpoint(toSchema, endpoints[path]);
   }
   return ret;
 };
 
-export const toJsonSchemaEndpoint = <Endpoint extends ZodApiEndpoint>(
+export const toJsonSchemaEndpoint = <Endpoint extends AnyApiEndpoint>(
+  toSchema: ToSchema,
   endpoint: Endpoint,
 ) => {
   const ret: Partial<Record<Method, JsonSchemaApiSpec>> = {};
   for (const method of Method) {
     const spec = endpoint[method];
     if (spec) {
-      ret[method] = toJsonSchemaApiSpec(spec);
+      ret[method] = toJsonSchemaApiSpec(toSchema, spec);
     }
   }
   return ret;
 };
 
-export const toJsonSchemaApiSpec = <Spec extends ZodApiSpec>(
+export const toJsonSchemaApiSpec = <Spec extends AnyApiSpec>(
+  toSchema: ToSchema,
   spec: Spec,
 ): JsonSchemaApiSpec => {
   const extraProps = extractExtraApiSpecProps(spec);
   const ret: JsonSchemaApiSpec = {
-    responses: toJsonSchemaResponses(spec.responses),
+    responses: toJsonSchemaResponses(toSchema, spec.responses),
   };
   for (const key of apiSpecRequestKeys) {
     if (spec[key]) {
@@ -58,7 +60,8 @@ export const toJsonSchemaApiSpec = <Spec extends ZodApiSpec>(
 };
 
 const toJsonSchemaResponses = (
-  responses: ZodAnyApiResponses,
+  toSchema: ToSchema,
+  responses: AnyApiResponses,
 ): JsonSchemaApiResponses => {
   const statusCodes = Object.keys(responses).map(Number) as StatusCode[];
   const ret: JsonSchemaApiResponses = {};
@@ -75,7 +78,3 @@ const toJsonSchemaResponses = (
   }
   return ret;
 };
-
-const toSchema = (s: z.ZodTypeAny) => {
-  return createSchema(s).schema as JSONSchema7;
-};

pkgs/typed-api-spec/src/valibot/index.ts

@@ -1,5 +1,4 @@
 export * from "./spec";
 export * from "./util";
-export * from "./jsonschema";
 export * from "./validator";
 export * from "./openapi";

pkgs/typed-api-spec/src/valibot/jsonschema.ts

@@ -1,6 +1,8 @@
 import { OpenAPIV3_1 } from "openapi-types";
-import { toJsonSchemaApiEndpoints } from "./jsonschema";
-import { toOpenApiDoc as toOpenApiDocOrg } from "../core";
+import {
+  JsonSchemaApiEndpoints,
+  toOpenApiDoc as toOpenApiDocOrg,
+} from "../core";
 import { AnyV } from "./util";
 import {
   BaseOpenApiSpec,
@@ -9,7 +11,9 @@ import {
   JsonSchemaOpenApiEndpoints,
   ToOpenApiResponse,
 } from "../core/openapi/spec";
-import { ValibotAnyApiResponse } from "./spec";
+import { ValibotAnyApiResponse, ValibotApiEndpoints } from "./spec";
+import { toJsonSchemaApiEndpoints as toEndpoints } from "../core/jsonschema";
+import { toJsonSchema } from "@valibot/to-json-schema";
 
 export const toOpenApiDoc = <E extends ValibotOpenApiEndpoints>(
   doc: Omit<OpenAPIV3_1.Document, "paths">,
@@ -37,3 +41,7 @@ export type ValibotOpenApiSpec<
   RequestHeaders extends AnyV = AnyV,
   Responses extends ValibotAnyOpenApiResponses = ValibotAnyOpenApiResponses,
 > = BaseOpenApiSpec<Params, Query, Body, RequestHeaders, Responses>;
+
+export const toJsonSchemaApiEndpoints = <E extends ValibotApiEndpoints>(
+  endpoints: E,
+): JsonSchemaApiEndpoints => toEndpoints(toJsonSchema, endpoints);

pkgs/typed-api-spec/src/valibot/openapi.ts

@@ -1,6 +1,8 @@
 import { OpenAPIV3_1 } from "openapi-types";
-import { toJsonSchemaApiEndpoints } from "./jsonschema";
-import { toOpenApiDoc as toOpenApiDocOrg } from "../core";
+import {
+  JsonSchemaApiEndpoints,
+  toOpenApiDoc as toOpenApiDocOrg,
+} from "../core";
 import {
   BaseOpenApiSpec,
   DefineOpenApiEndpoint,
@@ -9,7 +11,10 @@ import {
   ToOpenApiResponse,
 } from "../core/openapi/spec";
 import { z } from "zod";
-import { ZodAnyApiResponse } from "./index";
+import { ZodAnyApiResponse, ZodApiEndpoints } from "./index";
+import { toJsonSchemaApiEndpoints as toEndpoints } from "../core/jsonschema";
+import { createSchema } from "zod-openapi";
+import { JSONSchema7 } from "json-schema";
 
 export const toOpenApiDoc = <E extends ZodOpenApiEndpoints>(
   doc: Omit<OpenAPIV3_1.Document, "paths">,
@@ -36,3 +41,11 @@ export type ZodOpenApiSpec<
   RequestHeaders extends z.ZodTypeAny = z.ZodTypeAny,
   Responses extends ZodAnyOpenApiResponses = ZodAnyOpenApiResponses,
 > = BaseOpenApiSpec<Params, Query, Body, RequestHeaders, Responses>;
+
+export const toJsonSchemaApiEndpoints = <E extends ZodApiEndpoints>(
+  endpoints: E,
+): JsonSchemaApiEndpoints => toEndpoints(toSchema, endpoints);
+
+const toSchema = (s: z.ZodTypeAny) => {
+  return createSchema(s).schema as JSONSchema7;
+};