fumadocs-openapi 4.3.1 → 4.4.1

package/dist/index.d.ts

@@ -51,13 +51,20 @@ interface Renderer {
 
 declare const defaultRenderer: Renderer;
 
+/**
+ * Sample info of endpoint
+ */
 interface Endpoint {
     /**
-     * URL, including path and query parameters
+     * Request URL, including path and query parameters
      */
     url: string;
     method: string;
-    body?: unknown;
+    body?: {
+        schema: OpenAPIV3.SchemaObject;
+        mediaType: string;
+        sample: unknown;
+    };
     responses: Record<string, Response>;
     parameters: Parameter[];
 }
@@ -68,6 +75,7 @@ interface Parameter {
     name: string;
     in: string;
     schema: OpenAPIV3.SchemaObject;
+    sample: unknown;
 }
 
 interface CodeSample {

package/dist/index.js

@@ -143,6 +143,9 @@ function idToTitle(id) {
   return result.join("");
 }
 
+// src/endpoint.ts
+import { sample as sample2 } from "openapi-sampler";
+
 // src/utils/schema.ts
 function noRef(v) {
   return v;
@@ -173,18 +176,41 @@ function createEndpoint(path, method, baseUrl) {
   const params = [];
   const responses = {};
   for (const param of method.parameters) {
-    const schema = noRef(
-      param.schema ?? getPreferredMedia(param.content ?? {})?.schema
-    );
-    if (!schema) continue;
-    params.push({
-      name: param.name,
-      in: param.in,
-      schema
-    });
+    if (param.schema) {
+      params.push({
+        name: param.name,
+        in: param.in,
+        schema: noRef(param.schema),
+        sample: param.example ?? sample2(param.schema)
+      });
+    } else if (param.content) {
+      const key = getPreferredType(param.content);
+      const content = key ? param.content[key] : void 0;
+      if (!key || !content?.schema)
+        throw new Error(
+          `Cannot find parameter schema for ${param.name} in ${path} ${method.method}`
+        );
+      params.push({
+        name: param.name,
+        in: param.in,
+        schema: noRef(content.schema),
+        sample: content.example ?? param.example ?? sample2(content.schema)
+      });
+    }
+  }
+  let bodyOutput;
+  if (method.requestBody) {
+    const body = noRef(method.requestBody).content;
+    const type = getPreferredType(body);
+    const schema = type ? noRef(body[type].schema) : void 0;
+    if (!type || !schema)
+      throw new Error(`Cannot find body schema for ${path} ${method.method}`);
+    bodyOutput = {
+      schema,
+      mediaType: type,
+      sample: body[type].example ?? generateInput(method.method, schema)
+    };
   }
-  const body = noRef(method.requestBody)?.content ?? {};
-  const bodySchema = noRef(getPreferredMedia(body)?.schema);
   for (const [code, value] of Object.entries(method.responses)) {
     const mediaTypes = noRef(value).content ?? {};
     const responseSchema = noRef(getPreferredMedia(mediaTypes)?.schema);
@@ -209,7 +235,7 @@ function createEndpoint(path, method, baseUrl) {
     pathWithParameters = `${pathWithParameters}?${queryParams.toString()}`;
   return {
     url: new URL(`${baseUrl}${pathWithParameters}`).toString(),
-    body: bodySchema ? generateInput(method.method, bodySchema) : void 0,
+    body: bodyOutput,
     responses,
     method: method.method,
     parameters: params
@@ -233,15 +259,13 @@ function getSampleRequest(endpoint) {
   s.push(`curl -X ${endpoint.method} "${endpoint.url}"`);
   for (const param of endpoint.parameters) {
     if (param.in === "header") {
-      const value = generateInput(endpoint.method, param.schema);
-      const header = `${param.name}: ${toSampleInput(value)}`;
+      const header = `${param.name}: ${toSampleInput(param.sample)}`;
       s.push(`-H "${header}"`);
     }
-    if (param.in === "formData") {
-      console.log("Request example for form data is not supported");
-    }
   }
-  if (endpoint.body) s.push(`-d '${toSampleInput(endpoint.body)}'`);
+  if (endpoint.body?.mediaType === "multipart/form-data")
+    console.warn("Curl sample with form data body isn't supported.");
+  if (endpoint.body) s.push(`-d '${toSampleInput(endpoint.body.sample)}'`);
   return s.join(" \\\n  ");
 }
 
@@ -250,24 +274,25 @@ function getSampleRequest2(endpoint) {
   const s = [];
   const options = /* @__PURE__ */ new Map();
   const headers = {};
-  const formData = {};
   for (const param of endpoint.parameters) {
     if (param.in === "header") {
       headers[param.name] = generateInput(endpoint.method, param.schema);
     }
-    if (param.in === "formData") {
-      formData[param.name] = generateInput(endpoint.method, param.schema);
-    }
   }
   options.set("method", JSON.stringify(endpoint.method));
   if (Object.keys(headers).length > 0) {
     options.set("headers", JSON.stringify(headers, void 0, 2));
   }
-  if (Object.keys(formData).length > 0) {
+  if (endpoint.body?.mediaType === "multipart/form-data" && typeof endpoint.body.sample === "object" && endpoint.body.sample) {
     s.push(`const formData = new FormData();`);
-    for (const [key, value] of Object.entries(formData))
-      s.push(`formData.set(${key}, ${JSON.stringify(value)}`);
+    for (const [key, value] of Object.entries(endpoint.body.sample))
+      s.push(`formData.set(${key}, ${JSON.stringify(value)})`);
     options.set("body", "formData");
+  } else if (endpoint.body) {
+    options.set(
+      "body",
+      `JSON.stringify(${JSON.stringify(endpoint.body.sample, null, 2).split("\n").map((v, i) => i > 0 ? `  ${v}` : v).join("\n")})`
+    );
   }
   const optionsStr = Array.from(options.entries()).map(([k, v]) => `  ${k}: ${v}`).join(",\n");
   s.push(`fetch(${JSON.stringify(endpoint.url)}, {

package/dist/ui/index.js

@@ -71,12 +71,12 @@ function APIInfo({
   method = "GET",
   ...props
 }) {
-  return /* @__PURE__ */ jsxs("div", { className: cn("min-w-0 flex-1 prose-no-margin", className), ...props, children: [
+  return /* @__PURE__ */ jsxs("div", { className: cn("min-w-0 flex-1", className), ...props, children: [
     /* @__PURE__ */ jsxs(
       "div",
       {
         className: cn(
-          "sticky top-24 z-[2] flex flex-row items-center gap-2 rounded-lg border bg-fd-card p-3 md:top-10"
+          "sticky top-24 z-[2] mb-4 flex flex-row items-center gap-2 rounded-lg border bg-fd-card p-3 md:top-10"
         ),
         children: [
           /* @__PURE__ */ jsx(
@@ -94,7 +94,7 @@ function APIInfo({
         ]
       }
     ),
-    children
+    /* @__PURE__ */ jsx("div", { className: "prose-no-margin", children })
   ] });
 }
 function Property({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-openapi",
-  "version": "4.3.1",
+  "version": "4.4.1",
   "description": "Generate MDX docs for your OpenAPI spec",
   "keywords": [
     "NextJs",
@@ -56,8 +56,8 @@
     "react-hook-form": "^7.52.1",
     "shiki": "^1.11.1",
     "swr": "^2.2.5",
-    "fumadocs-core": "13.0.4",
-    "fumadocs-ui": "13.0.4"
+    "fumadocs-core": "13.0.6",
+    "fumadocs-ui": "13.0.6"
   },
   "devDependencies": {
     "@types/js-yaml": "^4.0.9",