feat: support hyphen character in path variables #65

Close #65
joolfe · Aug 25, 2020 · ea1671e · ea1671e
1 parent a4e8af4
commit ea1671e
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 4 deletions.
diff --git a/lib/index.js b/lib/index.js
@@ -162,7 +162,7 @@ function mapParameters (type) {
 }
 
 function extractPathParameters (path, paramsMeta) {
-  const matched = path.match(/{\s*[\w]+\s*}/g) || []
+  const matched = path.match(/{\s*[\w-]+\s*}/g) || []
   return matched.map(match => {
     const name = match.slice(1, -1)
     const { type = 'string', description, example } = paramsMeta[name] || {}

diff --git a/test/resources/input/PathParams.json b/test/resources/input/PathParams.json
@@ -1,6 +1,6 @@
 {
 	"info": {
-		"_postman_id": "c2a620d9-979e-4f39-b6bc-22282ce4b21a",
+		"_postman_id": "da50fa53-6326-4c7c-bfd8-6041a2c625d9",
 		"name": "Path Params",
 		"description": "Collection to test path parameters",
 		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
@@ -27,6 +27,27 @@
 			},
 			"response": []
 		},
+		{
+			"name": "Get one customer",
+			"request": {
+				"method": "GET",
+				"header": [],
+				"url": {
+					"raw": "https://api.io/customer/{{customer-id}}",
+					"protocol": "https",
+					"host": [
+						"api",
+						"io"
+					],
+					"path": [
+						"customer",
+						"{{customer-id}}"
+					]
+				},
+				"description": "Obtain one customer info"
+			},
+			"response": []
+		},
 		{
 			"name": "Get one users with description",
 			"request": {
@@ -53,7 +74,7 @@
 		{
 			"listen": "prerequest",
 			"script": {
-				"id": "3d4c9432-87d0-46d1-8e0a-7bf78b95838f",
+				"id": "8d6ddd6c-f1a8-4a68-91e0-07ab38f881a8",
 				"type": "text/javascript",
 				"exec": [
 					""
@@ -63,7 +84,7 @@
 		{
 			"listen": "test",
 			"script": {
-				"id": "bfa95668-f3ba-423f-93d3-152fbba765af",
+				"id": "e9cb3ab3-f140-42b3-8c12-17667c92c907",
 				"type": "text/javascript",
 				"exec": [
 					""

diff --git a/test/resources/output/PathParams.yml b/test/resources/output/PathParams.yml
@@ -23,6 +23,23 @@ paths:
           description: Successful response
           content:
             application/json: {}
+  '/customer/{customer-id}':
+    get:
+      tags:
+        - default
+      summary: Get one customer
+      description: Obtain one customer info
+      parameters:
+        - name: customer-id
+          in: path
+          schema:
+            type: string
+          required: true
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json: {}
   '/desc/{user_id}':
     get:
       tags: