Merge pull request #1192 from shockey/ft/ui-3820-path-operation-servers

OAS3: Path & Operation Servers

Author: shockey

src/execute/index.js

@@ -104,7 +104,7 @@ export function buildRequest(options) {
 
   // Base Template
   let req = {
-    url: baseUrl({spec, scheme, contextUrl, server, serverVariables}),
+    url: '',
     credentials: 'same-origin',
     headers: {
       // This breaks CORSs... removing this line... probably breaks oAuth. Need to address that
@@ -124,6 +124,15 @@ export function buildRequest(options) {
     req.userFetch = userFetch
   }
 
+  const operationRaw = getOperationRaw(spec, operationId)
+  if (!operationRaw) {
+    throw new OperationNotFoundError(`Operation ${operationId} not found`)
+  }
+
+  const {operation = {}, method, pathName} = operationRaw
+
+  req.url += baseUrl({spec, scheme, contextUrl, server, serverVariables, pathName, method})
+
   // Mostly for testing
   if (!operationId) {
     // Not removing req.cookies causes testing issues and would
@@ -134,13 +143,6 @@ export function buildRequest(options) {
     return req
   }
 
-  const operationRaw = getOperationRaw(spec, operationId)
-  if (!operationRaw) {
-    throw new OperationNotFoundError(`Operation ${operationId} not found`)
-  }
-
-  const {operation = {}, method, pathName} = operationRaw
-
   req.url += pathName // Have not yet replaced the path parameters
   req.method = (`${method}`).toUpperCase()
 
@@ -240,8 +242,11 @@ export function baseUrl(obj) {
   return specIsOAS3 ? oas3BaseUrl(obj) : swagger2BaseUrl(obj)
 }
 
-function oas3BaseUrl({spec, server, contextUrl, serverVariables = {}}) {
-  const servers = spec.servers
+function oas3BaseUrl({spec, pathName, method, server, contextUrl, serverVariables = {}}) {
+  const servers =
+    getIn(spec, ['paths', pathName, (method || '').toLowerCase(), 'servers']) ||
+    getIn(spec, ['paths', pathName, 'servers']) ||
+    getIn(spec, ['servers'])
 
   let selectedServerUrl = ''
   let selectedServerObj = null

test.js

@@ -37,37 +37,27 @@ describe('execute', () => {
       })
     })
 
-    it('should include host + http + baseUrl', function () {
-      // Given
-      const spec = {
-        host: 'swagger.io',
-        basePath: '/v1',
-      }
-
-      // When
-      const req = buildRequest({spec})
-
-      // Then
-      expect(req).toEqual({
-        url: 'http://swagger.io/v1',
-        credentials: 'same-origin',
-        headers: { }
-      })
-    })
-
     it('should include host + port', function () {
       // Given
       const spec = {
         host: 'foo.com:8081',
         basePath: '/v1',
+        paths: {
+          '/': {
+            get: {
+              operationId: 'foo'
+            }
+          }
+        }
       }
 
       // When
-      const req = buildRequest({spec})
+      const req = buildRequest({spec, operationId: 'foo'})
 
       // Then
       expect(req).toEqual({
-        url: 'http://foo.com:8081/v1',
+        url: 'http://foo.com:8081/v1/',
+        method: 'GET',
         credentials: 'same-origin',
         headers: { }
       })

test/execute/main.js

@@ -471,6 +471,104 @@ describe('buildRequest - OpenAPI Specification 3.0', function () {
 
       expect(res).toEqual('https://petstore.net')
     })
+    it('should use an explicitly chosen server at the operation level', function () {
+      const spec = {
+        openapi: '3.0.0',
+        servers: [
+          {
+            url: 'https://petstore.com'
+          },
+          {
+            url: 'https://petstore.net'
+          }
+        ],
+        paths: {
+          '/': {
+            get: {
+              servers: [
+                {
+                  url: 'https://petstore-operation.net/{path}',
+                  variables: {
+                    path: {
+                      default: 'foobar'
+                    }
+                  }
+                }
+              ]
+            }
+          }
+        }
+      }
+
+      const res = baseUrl({
+        spec,
+        server: 'https://petstore-operation.net/{path}',
+        pathName: '/',
+        method: 'GET'
+      })
+
+      const resWithVariables = baseUrl({
+        spec,
+        server: 'https://petstore-operation.net/{path}',
+        serverVariables: {
+          path: 'fizzbuzz'
+        },
+        pathName: '/',
+        method: 'GET'
+      })
+
+      expect(res).toEqual('https://petstore-operation.net/foobar')
+      expect(resWithVariables).toEqual('https://petstore-operation.net/fizzbuzz')
+    })
+
+    it('should use an explicitly chosen server at the path level', function () {
+      const spec = {
+        openapi: '3.0.0',
+        servers: [
+          {
+            url: 'https://petstore.com'
+          },
+          {
+            url: 'https://petstore.net'
+          }
+        ],
+        paths: {
+          '/': {
+            servers: [
+              {
+                url: 'https://petstore-path.net/{path}',
+                variables: {
+                  path: {
+                    default: 'foobar'
+                  }
+                }
+              }
+            ],
+            get: {}
+          }
+        }
+      }
+
+      const res = baseUrl({
+        spec,
+        server: 'https://petstore-path.net/{path}',
+        pathName: '/',
+        method: 'GET'
+      })
+
+      const resWithVariables = baseUrl({
+        spec,
+        server: 'https://petstore-path.net/{path}',
+        serverVariables: {
+          path: 'fizzbuzz'
+        },
+        pathName: '/',
+        method: 'GET'
+      })
+
+      expect(res).toEqual('https://petstore-path.net/foobar')
+      expect(resWithVariables).toEqual('https://petstore-path.net/fizzbuzz')
+    })
     it('should not use an explicitly chosen server that is not present in the spec', function () {
       const spec = {
         openapi: '3.0.0',