Merge pull request #20 from conqa/add-servers

Add servers

Author: Deadarius

src/DefinitionGenerator.ts

@@ -42,7 +42,8 @@ export class DefinitionGenerator {
       version = uuid.v4(),
       models,
       security,
-      securitySchemes
+      securitySchemes,
+      servers
     } = this.config;
 
     _.merge(this.definition, {
@@ -62,6 +63,10 @@ export class DefinitionGenerator {
       this.definition.components.securitySchemes = securitySchemes;
     }
 
+    if (servers) {
+      this.definition.servers = servers;
+    }
+
     this.definition.components.schemas = await parseModels(models, this.root);
 
     return this;

src/types.ts

@@ -16,6 +16,7 @@ export interface DefinitionConfig {
   version?: string;
   securitySchemes: OpenAPIV3.SecuritySchemeObject;
   security: Array<OpenAPIV3.SecurityRequirementObject>;
+  servers: Array<OpenAPIV3.ServerObject>;
   models: Array<Model>;
 }
 

test/project/openapi.yml

@@ -196,9 +196,9 @@ components:
             write: Grants write access
             admin: Grants access to admin operations
 info:
-  title: ''
+  title: Site API
   description: ''
-  version: 6e48be1a-d9be-41ef-95eb-41ffad58eac3
+  version: v1.0.0
 paths:
   '/create/{username}':
     post:
@@ -252,3 +252,17 @@ security:
   - bearerAuth:
       - read
       - write
+servers:
+  - url: 'https://{customerId}.saas-app.com:{port}/v2'
+    description: Production server (uses live data)
+    variables:
+      customerId:
+        default: demo
+        description: Customer ID assigned by the service provider
+      port:
+        enum:
+          - '443'
+          - '8443'
+        default: '443'
+  - url: 'https://sandbox-api.example.com:8443/v1'
+    description: Sandbox server (uses test data)

test/project/serverless.doc.yml

@@ -1,5 +1,8 @@
 documentation:
-  components:
+  version: "v1.0.0"
+  title: "Site API"
+  description: ${file(serverless.doc.description.yml):description}
+  authorization: Bearer <token>
   securitySchemes:
     bearerAuth:
       type: oauth2
@@ -14,6 +17,20 @@ documentation:
     - bearerAuth:
         - read
         - write
+  servers:
+    - url: https://{customerId}.saas-app.com:{port}/v2
+      description: Production server (uses live data)
+      variables:
+        customerId:
+          default: demo
+          description: Customer ID assigned by the service provider
+        port:
+          enum:
+            - "443"
+            - "8443"
+          default: "443"
+    - url: https://sandbox-api.example.com:8443/v1
+      description: Sandbox server (uses test data)
   models:
     - name: ErrorResponse
       description: This is an error