Merge pull request #15 from joemaidman/feat/favicon-and-docUrl

Feat/favicon and doc url
ojoanalogo · Aug 27, 2020 · 901c52c · 901c52c
2 parents 50411e3 + 2b6569b
commit 901c52c
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -84,7 +84,8 @@ await RedocModule.setup('/docs', app, document, redocOptions);
 
 | Option                  | Description                                                                                                                                           | Type         | Note                                       |
 | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------------------------------------ |
-| title                   | Web site title (e.g: ReDoc documentation)                                                                                                             | string       | Fallbacks to the document title if not set |
+| title                   | Web site title (e.g: ReDoc documentation)                                                                                                             | string       |
+| favicon                   | Web site favicon URL                                                                         | string       | Fallbacks to the document title if not set |
 | logo                    | Logo Options                                                                                                                                          | LogoOptions  | See LogoOptions table                      |
 | theme                   | Theme options                                                                                                                                         | ThemeOptions | See ThemeOptions info                      |
 | untrustedSpec           | If set, the spec is considered untrusted and all HTML/markdown is sanitized to prevent XSS, by default is false                                       | boolean      |

diff --git a/src/interfaces/redoc_options.interface.ts b/src/interfaces/redoc_options.interface.ts
@@ -1,6 +1,8 @@
 export interface RedocOptions {
   /** Web site title (e.g: ReDoc documentation) */
   title?: string;
+  /** Web site favicon URL */
+  favicon?: string;
   /** Logo Options */
   logo?: LogoOptions;
   /** Theme options */
@@ -36,6 +38,8 @@ export interface RedocOptions {
   disableSearch?: boolean;
   /** Shows only required fileds in request samples */
   onlyRequiredInSamples?: boolean;
+  /** Name of the swagger json spec file */
+  docName?: string;
 }
 
 export interface RedocTheme {

diff --git a/src/model/options.model.ts b/src/model/options.model.ts
@@ -6,6 +6,7 @@ export const schema = (document: OpenAPIObject) =>
     title: Joi.string()
       .optional()
       .default(document.info ? document.info.title : 'Swagger documentation'),
+    favicon: Joi.string().optional(),
     logo: {
       url: Joi.string()
         .optional()
@@ -58,5 +59,8 @@ export const schema = (document: OpenAPIObject) =>
       .default(false),
     onlyRequiredInSamples: Joi.boolean()
       .optional()
-      .default(false)
+      .default(false),
+    docName: Joi.string()
+      .optional()
+      .default('swagger')
   });
diff --git a/src/redoc-module.ts b/src/redoc-module.ts
@@ -86,7 +86,7 @@ export class RedocModule {
     const resolvedPath =
       finalPath.slice(-1) !== '/' ? finalPath + '/' : finalPath;
     // Serve swagger spec in another URL appended to the normalized path
-    const swaggerDocUrl = resolve(resolvedPath, 'swagger.json');
+    const docUrl = resolve(resolvedPath, `${options.docName}.json`);
     const hbs = handlebars.create({
       helpers: {
         toJSON: function(object: any) {
@@ -101,11 +101,12 @@ export class RedocModule {
     app.set('views', join(__dirname, '..', 'views'));
     // Serve ReDoc Frontend
     app.getHttpAdapter().get(finalPath, (req: Request, res: Response) => {
-      const { title, theme, logo, ...otherOptions } = options;
+      const { title, favicon, theme, logo, ...otherOptions } = options;
       const renderData = {
         data: {
-          title: title,
-          docUrl: swaggerDocUrl,
+          title,
+          docUrl,
+          favicon,
           options: otherOptions,
           ...(theme && {
             theme: {
@@ -122,7 +123,7 @@ export class RedocModule {
       });
     });
     // Serve swagger spec json
-    app.getHttpAdapter().get(swaggerDocUrl, (req: Request, res: Response) => {
+    app.getHttpAdapter().get(docUrl, (req: Request, res: Response) => {
       res.setHeader('Content-Type', 'application/json');
       res.send(document);
     });

diff --git a/views/redoc.handlebars b/views/redoc.handlebars
@@ -5,7 +5,9 @@
   <title>{{ data.title }}</title>
   <!-- needed for adaptive design -->
   <meta charset="utf-8" />
-  <link rel="shortcut icon" type="image/x-icon" href="https://quizizz.com/favicon.ico" />
+  {{#if data.favicon}}
+    <link rel="shortcut icon" type="image/x-icon" href="{{ data.favicon }}"/>
+  {{/if}} 
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
   <!--
@@ -41,4 +43,4 @@
   </script>
 </body>
 
-</html>
+</html>