feat: add custom host option (#79)

* Update package.json

* try

* Update package.json

* added host

* added host

* added option to set custom host

* added option to set custom host

* Update ServerlessAutoSwagger.test.ts

* Update README.md

* Update README.md

* Update tests/ServerlessAutoSwagger.test.ts

Co-authored-by: Brandon Faulkner <[email protected]>

Author: sebastijan94

README.md

@@ -44,6 +44,7 @@ custom:
         apiKeyHeaders: ['Authorization', 'anyOtherName']
         useStage: true | false
         basePath: '/string'
+        host: 'http://some-host'
         schemes: ['http', 'https', 'ws', 'wss']
         excludeStages: ['production', 'anyOtherStage']
 ```
@@ -58,6 +59,7 @@ custom:
 | `apiKeyHeaders`           | Array of strings used to define API keys used in auth headers                                                         | `[]`                                                                       | `apiKeyHeaders: ['Authorization', 'x-api-key']`          |
 | `useStage`                | Boolean to either use current stage in beginning of path or not                                                       | `false`                                                                    | `true` => `dev/swagger` for stage `dev`                  |
 | `basePath`                | String that can be prepended to every request. Should include leading `/`                                             | -                                                                          | `/some-base` => `http://localhost/some-base/my-endpoint` |
+| `host`                    | String that overrides the host. With this you can set your custom domain for your application endpoints               | -                                                                          | `http://some-host` => `{http://some-host}/my-endpoint`   |
 | `schemes`                 | Array (containing one of `http`, `https`, `ws`, or `wss`) for specifying schemes                                      | Scheme used to serve the API specification (reflecting Swagger's behavior) |                                                          |
 | `excludeStages`           | Array of strings that contains stages in which Swagger UI and Swagger JSON lambdas should **not** be deployed in.     | `[]`                                                                       |                                                          |
 

src/ServerlessAutoSwagger.ts

@@ -104,6 +104,7 @@ export default class ServerlessAutoSwagger {
     const autoswagger = this.serverless.service.custom?.autoswagger ?? {};
 
     if (autoswagger.basePath) this.swagger.basePath = autoswagger.basePath;
+    if (autoswagger.host) this.swagger.host = autoswagger.host;
     if (autoswagger.schemes) this.swagger.schemes = autoswagger.schemes;
 
     // There must be at least one or this `if` will be false

src/schemas/custom-properties.schema.json

@@ -19,6 +19,9 @@
         "basePath": {
           "type": "string"
         },
+        "host": {
+          "type": "string"
+        },
         "excludeStages": {
           "default": [],
           "items": {

src/types/serverless-plugin.types.d.ts

@@ -37,6 +37,7 @@ export interface AutoSwaggerCustomConfig {
   useStage?: boolean;
   swaggerPath?: string;
   basePath?: string;
+  host?: string;
   schemes?: SwaggerScheme[];
   excludeStages?: string[];
 }

tests/ServerlessAutoSwagger.test.ts

@@ -819,6 +819,7 @@ describe('ServerlessAutoSwagger', () => {
           ],
           {
             basePath: '/bp',
+            host: 'some-host',
             schemes: ['ws'],
             swaggerFiles: [fileName],
           }
@@ -837,6 +838,7 @@ describe('ServerlessAutoSwagger', () => {
         swagger: '2.0',
         schemes: ['ws'],
         basePath: '/bp',
+        host: 'some-host',
         ...swaggerDoc,
       });
     });