fumadocs-openapi 5.0.1 → 5.0.2

package/dist/server/index.js

@@ -28,7 +28,28 @@ function getPreferredType(body) {
     return typeof value === 'string' ? value : JSON.stringify(value, null, 2);
 }
 
-function generateSample(path, method, baseUrl) {
+function getSecurities(requirement, document) {
+    const results = [];
+    const schemas = document.components?.securitySchemes ?? {};
+    for (const [key, scopes] of Object.entries(requirement)){
+        if (!(key in schemas)) return [];
+        const schema = noRef(schemas[key]);
+        results.push({
+            ...schema,
+            scopes
+        });
+    }
+    return results;
+}
+function getSecurityPrefix(security) {
+    if (security.type === 'http') return ({
+        basic: 'Basic',
+        bearer: 'Bearer'
+    })[security.scheme];
+    if (security.type === 'oauth2') return 'Bearer';
+}
+
+function generateSample(path, method, { baseUrl, document }) {
     const params = [];
     const responses = {};
     for (const param of method.parameters){
@@ -51,6 +72,20 @@ function generateSample(path, method, baseUrl) {
             });
         }
     }
+    const requirements = method.security ?? document.security;
+    if (requirements && requirements.length > 0) {
+        for (const security of getSecurities(requirements[0], document)){
+            const prefix = getSecurityPrefix(security);
+            params.push({
+                name: 'Authorization',
+                schema: {
+                    type: 'string'
+                },
+                sample: prefix ? `${prefix} <token>` : '<token>',
+                in: 'header'
+            });
+        }
+    }
     let bodyOutput;
     if (method.requestBody) {
         const body = noRef(method.requestBody).content;
@@ -199,7 +234,7 @@ func main() {
 ${Array.from(variables.entries()).map(([k, v])=>`  ${k} := ${v}`).join('\n')}
   ${additional.join('\n  ')}
   req, _ := http.NewRequest("${endpoint.method}", url, ${variables.has('payload') ? 'payload' : 'nil'})
-  ${Array.from(headers.entries()).map(([key, value])=>`req.Header.Add("${key}", ${value})`).join('\n')}
+  ${Array.from(headers.entries()).map(([key, value])=>`req.Header.Add("${key}", ${value})`).join('\n  ')}
   res, _ := http.DefaultClient.Do(req)
   defer res.Body.Close()
   body, _ := ioutil.ReadAll(res.Body)
@@ -220,20 +255,6 @@ async function getTypescriptSchema(endpoint, code) {
     }
 }
 
-function getScheme(requirement, document) {
-    const results = [];
-    const schemas = document.components?.securitySchemes ?? {};
-    for (const [key, scopes] of Object.entries(requirement)){
-        if (!(key in schemas)) return [];
-        const schema = noRef(schemas[key]);
-        results.push({
-            ...schema,
-            scopes
-        });
-    }
-    return results;
-}
-
 function Playground({ path, method, ctx }) {
     let currentId = 0;
     const bodyContent = noRef(method.requestBody)?.content;
@@ -266,7 +287,7 @@ function getAuthorizationField(method, ctx) {
     if (security.length === 0) return;
     const singular = security.find((requirements)=>Object.keys(requirements).length === 1);
     if (!singular) return;
-    const scheme = getScheme(singular, ctx.document)[0];
+    const scheme = getSecurities(singular, ctx.document)[0];
     return {
         type: 'string',
         name: 'Authorization',
@@ -676,7 +697,7 @@ function Operation({ path, method, ctx, hasHead }) {
         }, "body"));
     }
     const parameterGroups = new Map();
-    const endpoint = generateSample(path, method, ctx.baseUrl);
+    const endpoint = generateSample(path, method, ctx);
     for (const param of method.parameters){
         const pInfo = endpoint.parameters.find((item)=>item.name === param.name && item.in === param.in);
         if (!pInfo) continue;
@@ -778,15 +799,12 @@ function AuthSection({ ctx: { document, renderer }, requirements }) {
     let id = 0;
     const info = [];
     for (const requirement of requirements){
-        if (info.length > 0) info.push(`---`);
-        for (const schema of getScheme(requirement, document)){
+        for (const schema of getSecurities(requirement, document)){
+            const prefix = getSecurityPrefix(schema);
             if (schema.type === 'http') {
                 info.push(/*#__PURE__*/ jsxs(renderer.Property, {
                     name: "Authorization",
-                    type: {
-                        basic: 'Basic <token>',
-                        bearer: 'Bearer <token>'
-                    }[schema.scheme] ?? '<token>',
+                    type: prefix ? `${prefix} <token>` : '<token>',
                     required: true,
                     children: [
                         schema.description ? /*#__PURE__*/ jsx(Markdown, {
@@ -806,7 +824,7 @@ function AuthSection({ ctx: { document, renderer }, requirements }) {
             if (schema.type === 'oauth2') {
                 info.push(/*#__PURE__*/ jsxs(renderer.Property, {
                     name: "Authorization",
-                    type: "Bearer <token>",
+                    type: prefix ? `${prefix} <token>` : '<token>',
                     required: true,
                     children: [
                         schema.description ? /*#__PURE__*/ jsx(Markdown, {
@@ -820,15 +838,14 @@ function AuthSection({ ctx: { document, renderer }, requirements }) {
                                 })
                             ]
                         }),
-                        /*#__PURE__*/ jsxs("p", {
+                        schema.scopes.length > 0 ? /*#__PURE__*/ jsxs("p", {
                             children: [
-                                "Scope:",
-                                ' ',
+                                "Scope: ",
                                 /*#__PURE__*/ jsx("code", {
-                                    children: schema.scopes.length > 0 ? schema.scopes.join(', ') : 'none'
+                                    children: schema.scopes.join(', ')
                                 })
                             ]
-                        })
+                        }) : null
                     ]
                 }, id++));
             }

package/package.json

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