feat: parse json schema support

Author: hyoban

.vitepress/theme/components/Route.vue

@@ -124,6 +124,7 @@
 import MarkdownIt from 'markdown-it';
 import type { Route } from '../types';
 import CopyButton from './CopyButton.vue';
+import { parseJsonSchema } from './parse-json-schema';
 
 const props = defineProps<{
   namespace: string,
@@ -134,7 +135,11 @@ const props = defineProps<{
     description: string | null,
     siteUrl: string | null,
     image: string | null,
-  }[] },
+  }[],
+  param?: any,
+  query?: any,
+  location?: string,
+},
   test?: {
     code: number,
     message?: string,
@@ -143,9 +148,10 @@ const props = defineProps<{
 
 const demoUrl = props.data.example ? ('https://rsshub.app' + props.data.example) : null;
 const path = typeof props.data.path === "string" ? props.data.path : props.data.path[0];
+const param = parseJsonSchema(props.data.param);
 const paramMatch = path.match?.(/(?<=:).*?(?=\/|$)/g)?.map((item) => {
   const name = item.replace(/:|\?|\+|\*/g, '');
-  let parameter = props.data.parameters?.[name];
+  let parameter = param?.[name] || props.data.parameters?.[name];
   if (typeof parameter === "string") {
     parameter = {
       description: parameter,

.vitepress/theme/components/parse-json-schema.ts

@@ -0,0 +1,53 @@
+import type { JSONSchema4 } from "json-schema";
+
+export type ParamDesc = {
+  description?: string;
+  default?: string;
+  options?: {
+    value: string;
+    label: string;
+  }[];
+  optional?: boolean;
+};
+
+export function parseJsonSchema(
+  schema?: JSONSchema4
+): Record<string, ParamDesc> {
+  if (schema?.type !== "object") {
+    return {};
+  }
+  const properties = schema.properties || {};
+  const required = Array.isArray(schema.required) ? schema.required : [];
+  const result: Record<string, ParamDesc> = {};
+
+  for (const [key, value] of Object.entries(properties)) {
+    if (typeof value === "boolean") continue;
+
+    const propertySchema = value as JSONSchema4;
+    const isOptional = !required.includes(key);
+
+    // Extract default value
+    const defaultValue =
+      propertySchema.default !== undefined
+        ? String(propertySchema.default)
+        : undefined;
+
+    // Extract options from enum
+    const options = propertySchema.anyOf
+      ? propertySchema.anyOf
+          .filter((val) => "const" in val && "description" in val)
+          .map((val) => ({
+            label: String(val.description),
+            value: String(val.const),
+          }))
+      : undefined;
+
+    result[key] = {
+      optional: isOptional,
+      default: defaultValue,
+      description: propertySchema.description,
+      ...(options && { options }),
+    };
+  }
+  return result;
+}

package.json

@@ -6,6 +6,7 @@
     "docs:preview": "vitepress preview"
   },
   "devDependencies": {
+    "@types/json-schema": "7.0.15",
     "markdown-it": "14.1.0",
     "vitepress": "1.6.4",
     "vue": "3.5.25"