Escape colons in path. Fixes #320

cdimascio · Oct 30, 2020 · 1e3bd24 · 1e3bd24
1 parent a3908cd
commit 1e3bd24
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 17 deletions.
diff --git a/src/framework/openapi.spec.loader.ts b/src/framework/openapi.spec.loader.ts
@@ -71,9 +71,9 @@ export class OpenApiSpecLoader {
               }
               const openApiRoute = `${bp}${path}`;
               const expressRoute = `${openApiRoute}`
-                .split('/')
+                .split(':')
                 .map(toExpressParams)
-                .join('/');
+                .join('\\:');
 
               routes.push({
                 basePath: bp,

diff --git a/test/path.params.spec.ts b/test/path.params.spec.ts
@@ -22,12 +22,10 @@ describe('path params', () => {
             id: req.params.id,
           });
         });
-        app.get(`${app.basePath}/users:lookup`, (req, res) => {
-          res.json([
-            {
-              id: req.query.name,
-            },
-          ]);
+        app.get(`${app.basePath}/user_lookup\\::name`, (req, res) => {
+          res.json({
+            id: req.params.name,
+          });
         });
         app.get(`${app.basePath}/multi_users/:ids?`, (req, res) => {
           res.json({
@@ -77,11 +75,9 @@ describe('path params', () => {
 
   it("should handle :'s in path parameters", async () =>
     request(app)
-      .get(`${app.basePath}/users:lookup`)
-      .query({ name: 'carmine' })
+      .get(`${app.basePath}/user_lookup:carmine`)
       .expect(200)
       .then((r) => {
-        expect(r.body).to.be.an('array');
-        expect(r.body[0].id).to.equal('carmine');
+        expect(r.body.id).to.equal('carmine');
       }));
 });
diff --git a/test/resources/path.params.yaml b/test/resources/path.params.yaml
@@ -54,11 +54,11 @@ paths:
             application/json:
               schema:
                 type: object
-  "/users:lookup":
+  "/user_lookup:{name}":
     get:
       parameters:
         - name: name
-          in: query
+          in: path
           required: true
           schema:
             type: string
@@ -68,9 +68,7 @@ paths:
           content:
             application/json:
               schema:
-                type: array
-                items:
-                  $ref: "#/components/schemas/User"
+                $ref: "#/components/schemas/User"
 components:
   schemas:
     User: