feat: add option to change project title (#80)

* add option to change project title * change markdown file * unit tests modified * add suggested changes
completecoding · Jul 5, 2022 · 9dea3b6 · 9dea3b6
1 parent 54fddb4
commit 9dea3b6
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -36,6 +36,7 @@ All config options are optional. Defaults are shown in the table below.
 ```yaml
 custom:
     autoswagger:
+        title: 'string'
         apiType: 'http' | 'httpApi'
         generateSwaggerOnDeploy: true | false
         typefiles: ['./src/types/typefile1.d.ts', './src/subfolder/helper.d.ts']
@@ -52,6 +53,7 @@ custom:
 | Option                    | Description                                                                                                           | Default                                                                    | Example                                                  |
 | ------------------------- | --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------- |
 | `generateSwaggerOnDeploy` | Boolean which indicates whether to generate a new swagger file on deployment                                          | `true`                                                                     |                                                          |
+| `title`                   | String to overwrite the project title with a custom one                                                               | Serverless service name                                                    |                                                          |
 | `typefiles`               | Array of strings which defines where to find the typescript types to use for the request and response bodies          | `['./src/types/api-types.d.ts']`                                           |                                                          |
 | `swaggerFiles`            | Array of string which will merge custom json OpenApi 2.0 files to the generated swagger                               | `[]`                                                                       |                                                          |
 | `swaggerPath`             | String for customize swagger path. Your new swagger UI will be available at `https://{your-url-domain}/{swaggerPath}` | `swagger`                                                                  | `my-swagger` => `https://{your-url-domain}/my-swagger`   |

diff --git a/src/ServerlessAutoSwagger.ts b/src/ServerlessAutoSwagger.ts
@@ -106,6 +106,7 @@ export default class ServerlessAutoSwagger {
     if (autoswagger.basePath) this.swagger.basePath = autoswagger.basePath;
     if (autoswagger.host) this.swagger.host = autoswagger.host;
     if (autoswagger.schemes) this.swagger.schemes = autoswagger.schemes;
+    if (autoswagger.title) this.swagger.info.title = autoswagger.title;
 
     // There must be at least one or this `if` will be false
     if (autoswagger.swaggerFiles?.length) this.gatherSwaggerFiles(autoswagger.swaggerFiles);
@@ -197,8 +198,8 @@ export default class ServerlessAutoSwagger {
   };
 
   generateSwagger = async () => {
-    this.gatherSwaggerOverrides();
     await this.gatherTypes();
+    this.gatherSwaggerOverrides();
     this.generateSecurity();
     this.generatePaths();
 

diff --git a/src/types/serverless-plugin.types.d.ts b/src/types/serverless-plugin.types.d.ts
@@ -39,6 +39,7 @@ export interface AutoSwaggerCustomConfig {
   basePath?: string;
   host?: string;
   schemes?: SwaggerScheme[];
+  title?: string;
   excludeStages?: string[];
 }
 

diff --git a/src/types/swagger.types.d.ts b/src/types/swagger.types.d.ts
@@ -15,7 +15,7 @@ export interface Swagger {
 
 // Info Section
 export interface Info {
-  title: string;
+  title?: string;
   description?: string;
   version: string;
   termsOfService?: string;

diff --git a/tests/ServerlessAutoSwagger.test.ts b/tests/ServerlessAutoSwagger.test.ts
@@ -820,6 +820,7 @@ describe('ServerlessAutoSwagger', () => {
           {
             basePath: '/bp',
             host: 'some-host',
+            title: 'My API Title',
             schemes: ['ws'],
             swaggerFiles: [fileName],
           }
@@ -832,7 +833,7 @@ describe('ServerlessAutoSwagger', () => {
 
       expect(serverlessAutoSwagger.swagger).toEqual({
         definitions: expect.any(Object),
-        info: expect.any(Object),
+        info: { title: 'My API Title', version: '1' },
         paths: expect.any(Object),
         securityDefinitions: expect.any(Object),
         swagger: '2.0',