fumadocs-openapi 3.1.2 → 3.2.0

package/dist/index.d.ts

@@ -44,6 +44,48 @@ interface Renderer {
 }
 declare const defaultRenderer: Renderer;
 
+interface CodeSample {
+    lang: string;
+    label: string;
+    source: string;
+}
+
+interface RouteInformation {
+    path: string;
+    summary?: string;
+    description?: string;
+    methods: MethodInformation[];
+}
+interface MethodInformation extends OpenAPIV3.OperationObject {
+    parameters: OpenAPIV3.ParameterObject[];
+    method: string;
+}
+interface RenderContext {
+    renderer: Renderer;
+    document: OpenAPIV3.Document;
+    baseUrl: string;
+    generateCodeSamples?: (endpoint: Endpoint) => CodeSample[];
+}
+
+interface Endpoint {
+    /**
+     * URL, including path and query parameters
+     */
+    url: string;
+    method: string;
+    body?: unknown;
+    responses: Record<string, Response>;
+    parameters: Parameter[];
+}
+interface Response {
+    schema: OpenAPIV3.SchemaObject;
+}
+interface Parameter {
+    name: string;
+    in: string;
+    schema: OpenAPIV3.SchemaObject;
+}
+
 interface GenerateOptions {
     /**
      * The imports of your MDX components.
@@ -60,6 +102,10 @@ interface GenerateOptions {
      * A `full: true` property will be added by default.
      */
     frontmatter?: (title: string, description: string | undefined) => Record<string, unknown>;
+    /**
+     * Generate code samples for endpoint
+     */
+    generateCodeSamples?: (endpoint: Endpoint) => CodeSample[];
     renderer?: Partial<Renderer>;
 }
 interface GenerateTagOutput {
@@ -99,22 +145,6 @@ interface Config extends GenerateOptions {
 }
 declare function generateFiles({ input, output, name: nameFn, per, cwd, ...options }: Config): Promise<void>;
 
-interface RouteInformation {
-    path: string;
-    summary?: string;
-    description?: string;
-    methods: MethodInformation[];
-}
-interface MethodInformation extends OpenAPIV3.OperationObject {
-    parameters: OpenAPIV3.ParameterObject[];
-    method: string;
-}
-interface RenderContext {
-    renderer: Renderer;
-    document: OpenAPIV3.Document;
-    baseUrl: string;
-}
-
 declare function createElement(name: string, props: object, ...child: string[]): string;
 
 export { type APIInfoProps, type Config, type GenerateOperationOutput, type GenerateOptions, type GenerateTagOutput, type MethodInformation, type ObjectCollapsibleProps, type PropertyProps, type RenderContext, type Renderer, type RequestProps, type ResponseProps, type ResponsesProps, type RouteInformation, createElement, defaultRenderer, generate, generateFiles, generateOperations, generateTags };

package/dist/index.js

@@ -182,8 +182,10 @@ function createEndpoint(path, method, baseUrl) {
         toSampleInput(value)
       );
   }
+  if (queryParams.size > 0)
+    pathWithParameters = `${pathWithParameters}?${queryParams.toString()}`;
   return {
-    url: new URL(pathWithParameters, baseUrl).toString(),
+    url: new URL(`${baseUrl}${pathWithParameters}`).toString(),
     body: bodySchema ? generateInput(method.method, bodySchema) : void 0,
     responses,
     method: method.method,
@@ -446,21 +448,30 @@ async function renderOperation(path, method, ctx, noTitle = false) {
     info.push(heading(level, group), ...parameters);
   }
   info.push(getResponseTable(method));
+  const samples = dedupe([
+    {
+      label: "cURL",
+      source: getSampleRequest(endpoint),
+      lang: "bash"
+    },
+    {
+      label: "JavaScript",
+      source: getSampleRequest2(endpoint),
+      lang: "js"
+    },
+    ...ctx.generateCodeSamples?.(endpoint) ?? [],
+    ...method["x-codeSamples"] ?? []
+  ]);
   example.push(
     ctx.renderer.Requests(
-      ["cURL", "JavaScript"],
-      [
-        ctx.renderer.Request({
-          name: "cURL",
-          code: getSampleRequest(endpoint),
-          language: "bash"
-        }),
-        ctx.renderer.Request({
-          name: "JavaScript",
-          code: getSampleRequest2(endpoint),
-          language: "js"
+      samples.map((s) => s.label),
+      samples.map(
+        (s) => ctx.renderer.Request({
+          name: s.label,
+          code: s.source,
+          language: s.lang
         })
-      ]
+      )
     )
   );
   example.push(await getResponseTabs(endpoint, method, ctx));
@@ -469,6 +480,16 @@ async function renderOperation(path, method, ctx, noTitle = false) {
     ctx.renderer.APIExample(example)
   ]);
 }
+function dedupe(samples) {
+  const set = /* @__PURE__ */ new Set();
+  const out = [];
+  for (let i = samples.length - 1; i >= 0; i--) {
+    if (set.has(samples[i].label)) continue;
+    set.add(samples[i].label);
+    out.unshift(samples[i]);
+  }
+  return out;
+}
 function getAuthSection(requirements, { document, renderer }) {
   const info = [];
   const schemas = document.components?.securitySchemes ?? {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-openapi",
-  "version": "3.1.2",
+  "version": "3.2.0",
   "description": "Generate MDX docs for your OpenAPI spec",
   "keywords": [
     "NextJs",