feat: Add download file option

README.md

@@ -212,6 +212,7 @@ You can use all of the following options with the standalone version of the <red
 * `generatedPayloadSamplesMaxDepth` - set the maximum render depth for JSON payload samples (responses and request body). The default value is `10`.
 * `maxDisplayedEnumValues` - display only specified number of enum values. hide rest values under spoiler.
 * `hideDownloadButton` - do not show "Download" spec button. **THIS DOESN'T MAKE YOUR SPEC PRIVATE**, it just hides the button.
+* `downloadFileName` - set a custom file name for the downloaded API definition file. The file is always in JSON format regardless of the file extension you set with this option. The default file name is `openapi.json`. **This option is supported only in redoc-cli `build`**.
 * `hideHostname` - if set, the protocol and hostname is not shown in the operation definition.
 * `hideLoading` - do not show loading animation. Useful for small docs.
 * `hideFab` - do not show FAB in mobile view. Useful for implementing a custom floating action button.

src/components/__tests__/__snapshots__/DiscriminatorDropdown.test.tsx.snap

@@ -74,6 +74,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
                   "options": RedocNormalizedOptions {
                     "allowedMdComponents": Object {},
                     "disableSearch": false,
+                    "downloadFileName": "openapi.json",
                     "enumSkipQuotes": false,
                     "expandDefaultServerVariables": false,
                     "expandResponses": Object {},
@@ -324,6 +325,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
                   "options": RedocNormalizedOptions {
                     "allowedMdComponents": Object {},
                     "disableSearch": false,
+                    "downloadFileName": "openapi.json",
                     "enumSkipQuotes": false,
                     "expandDefaultServerVariables": false,
                     "expandResponses": Object {},
@@ -550,6 +552,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
             "options": RedocNormalizedOptions {
               "allowedMdComponents": Object {},
               "disableSearch": false,
+              "downloadFileName": "openapi.json",
               "enumSkipQuotes": false,
               "expandDefaultServerVariables": false,
               "expandResponses": Object {},
@@ -841,6 +844,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
                   "options": RedocNormalizedOptions {
                     "allowedMdComponents": Object {},
                     "disableSearch": false,
+                    "downloadFileName": "openapi.json",
                     "enumSkipQuotes": false,
                     "expandDefaultServerVariables": false,
                     "expandResponses": Object {},
@@ -1091,6 +1095,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
                   "options": RedocNormalizedOptions {
                     "allowedMdComponents": Object {},
                     "disableSearch": false,
+                    "downloadFileName": "openapi.json",
                     "enumSkipQuotes": false,
                     "expandDefaultServerVariables": false,
                     "expandResponses": Object {},
@@ -1317,6 +1322,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
             "options": RedocNormalizedOptions {
               "allowedMdComponents": Object {},
               "disableSearch": false,
+              "downloadFileName": "openapi.json",
               "enumSkipQuotes": false,
               "expandDefaultServerVariables": false,
               "expandResponses": Object {},
@@ -1566,6 +1572,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
         "options": RedocNormalizedOptions {
           "allowedMdComponents": Object {},
           "disableSearch": false,
+          "downloadFileName": "openapi.json",
           "enumSkipQuotes": false,
           "expandDefaultServerVariables": false,
           "expandResponses": Object {},
@@ -1854,6 +1861,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
             "options": RedocNormalizedOptions {
               "allowedMdComponents": Object {},
               "disableSearch": false,
+              "downloadFileName": "openapi.json",
               "enumSkipQuotes": false,
               "expandDefaultServerVariables": false,
               "expandResponses": Object {},
@@ -2104,6 +2112,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
             "options": RedocNormalizedOptions {
               "allowedMdComponents": Object {},
               "disableSearch": false,
+              "downloadFileName": "openapi.json",
               "enumSkipQuotes": false,
               "expandDefaultServerVariables": false,
               "expandResponses": Object {},
@@ -2330,6 +2339,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
       "options": RedocNormalizedOptions {
         "allowedMdComponents": Object {},
         "disableSearch": false,
+        "downloadFileName": "openapi.json",
         "enumSkipQuotes": false,
         "expandDefaultServerVariables": false,
         "expandResponses": Object {},

src/services/RedocNormalizedOptions.ts

@@ -27,6 +27,7 @@ export interface RedocRawOptions {
   untrustedSpec?: boolean | string;
   hideLoading?: boolean | string;
   hideDownloadButton?: boolean | string;
+  downloadFileName?: string;
   disableSearch?: boolean | string;
   onlyRequiredInSamples?: boolean | string;
   showExtensions?: boolean | string | string[];
@@ -225,6 +226,7 @@ export class RedocNormalizedOptions {
   pathInMiddlePanel: boolean;
   untrustedSpec: boolean;
   hideDownloadButton: boolean;
+  downloadFileName: string;
   disableSearch: boolean;
   onlyRequiredInSamples: boolean;
   showExtensions: boolean | string[];
@@ -291,6 +293,7 @@ export class RedocNormalizedOptions {
     this.pathInMiddlePanel = argValueToBoolean(raw.pathInMiddlePanel);
     this.untrustedSpec = argValueToBoolean(raw.untrustedSpec);
     this.hideDownloadButton = argValueToBoolean(raw.hideDownloadButton);
+    this.downloadFileName = raw.downloadFileName || 'openapi.json';
     this.disableSearch = argValueToBoolean(raw.disableSearch);
     this.onlyRequiredInSamples = argValueToBoolean(raw.onlyRequiredInSamples);
     this.showExtensions = RedocNormalizedOptions.normalizeShowExtensions(raw.showExtensions);

src/services/SpecStore.ts

@@ -24,7 +24,7 @@ export class SpecStore {
     private options: RedocNormalizedOptions,
   ) {
     this.parser = new OpenAPIParser(spec, specUrl, options);
-    this.info = new ApiInfoModel(this.parser);
+    this.info = new ApiInfoModel(this.parser, this.options);
     this.externalDocs = this.parser.spec.externalDocs;
     this.contentItems = MenuBuilder.buildStructure(this.parser, this.options);
     this.securitySchemes = new SecuritySchemesModel(this.parser);

src/services/__tests__/models/ApiInfo.test.ts

@@ -62,5 +62,30 @@ describe('Models', () => {
       const { license = { identifier: null } } = new ApiInfoModel(parser);
       expect(license.identifier).toEqual('MIT');
     });
+
+    test('should correctly populate default download file name', () => {
+      parser.spec = {
+        openapi: '3.0.0',
+        info: {
+          description: 'Test description',
+        },
+      } as any;
+
+      const info = new ApiInfoModel(parser);
+      expect(info.downloadFileName).toEqual('openapi.json');
+    });
+
+    test('should correctly populate download file name', () => {
+      parser.spec = {
+        openapi: '3.0.0',
+        info: {
+          description: 'Test description',
+        },
+      } as any;
+
+      const opts = new RedocNormalizedOptions({ downloadFileName: 'filename.json' });
+      const info = new ApiInfoModel(parser, opts);
+      expect(info.downloadFileName).toEqual('filename.json');
+    });
   });
 });

src/services/models/ApiInfo.ts

@@ -1,6 +1,7 @@
 import { OpenAPIContact, OpenAPIInfo, OpenAPILicense } from '../../types';
 import { IS_BROWSER } from '../../utils/';
 import { OpenAPIParser } from '../OpenAPIParser';
+import { RedocNormalizedOptions } from '../RedocNormalizedOptions';
 
 export class ApiInfoModel implements OpenAPIInfo {
   title: string;
@@ -15,7 +16,10 @@ export class ApiInfoModel implements OpenAPIInfo {
   downloadLink?: string;
   downloadFileName?: string;
 
-  constructor(private parser: OpenAPIParser) {
+  constructor(
+    private parser: OpenAPIParser,
+    private options: RedocNormalizedOptions = new RedocNormalizedOptions({}),
+  ) {
     Object.assign(this, parser.spec.info);
     this.description = parser.spec.info.description || '';
     this.summary = parser.spec.info.summary || '';
@@ -44,7 +48,7 @@ export class ApiInfoModel implements OpenAPIInfo {
 
   private getDownloadFileName(): string | undefined {
     if (!this.parser.specUrl) {
-      return 'swagger.json';
+      return this.options.downloadFileName;
     }
     return undefined;
   }