Skip to content

Commit

Permalink
Include query parameters and headers in the generated Postman collect…
Browse files Browse the repository at this point in the history 
…ion. (#537)

* Include query parameters in the generated Postman collection.

* Style fixes

* Also include headers in the Postman collection.

* Also include JSON content type headers for good measure.

* Update the tests.

* Add a test to validate the body parameters in a Postman collection.

* Remove the "Content-Type" header again, as we are actually sending content as form data.

* Add a query test and make the tests more deterministic.

* PR fixes.
  • Loading branch information
@MrMage @shalvah
MrMage authored and shalvah committed Jul 16, 2019
1 parent 5f9babf commit 573e9ef
Show file tree
Hide file tree
Showing 7 changed files with 376 additions and 10 deletions.
19 changes: 17 additions & 2 deletions src/Postman/CollectionWriter.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,14 +56,29 @@ public function getCollection()
return [
'name' => $route['title'] != '' ? $route['title'] : url($route['uri']),
'request' => [
'url' => url($route['uri']),
'url' => url($route['uri']).(collect($route['queryParameters'])->isEmpty()
? ''
: ('?'.implode('&', collect($route['queryParameters'])->map(function ($parameter, $key) {
return $key.'='.($parameter['value'] ?? '');
})->all()))),
'method' => $route['methods'][0],
'header' => collect($route['headers'])
->union([
'Accept' => 'application/json',
])
->map(function ($value, $header) {
return [
'key' => $header,
'value' => $value,
];
})
->values()->all(),
'body' => [
'mode' => $mode,
$mode => collect($route['bodyParameters'])->map(function ($parameter, $key) {
return [
'key' => $key,
'value' => isset($parameter['value']) ? $parameter['value'] : '',
'value' => $parameter['value'] ?? '',
'type' => 'text',
'enabled' => true,
];
Expand Down
56 changes: 55 additions & 1 deletion tests/Fixtures/collection.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1,55 @@
{"variables":[],"info":{"name":"Laravel API","_postman_id":"","description":"","schema":"https:\/\/schema.getpostman.com\/json\/collection\/v2.0.0\/collection.json"},"item":[{"name":"Group A","description":"","item":[{"name":"Example title.","request":{"url":"http:\/\/localhost\/api\/test","method":"GET","body":{"mode":"formdata","formdata":[]},"description":"This will be the long description.\nIt can also be multiple lines long.","response":[]}},{"name":"http:\/\/localhost\/api\/responseTag","request":{"url":"http:\/\/localhost\/api\/responseTag","method":"POST","body":{"mode":"formdata","formdata":[]},"description":"","response":[]}}]}]}
{
"variables": [],
"info": {
"name": "Laravel API",
"_postman_id": "",
"description": "",
"schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.0.0\/collection.json"
},
"item": [
{
"name": "Group A",
"description": "",
"item": [
{
"name": "Example title.",
"request": {
"url": "http:\/\/localhost\/api\/test",
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "formdata",
"formdata": []
},
"description": "This will be the long description.\nIt can also be multiple lines long.",
"response": []
}
},
{
"name": "http:\/\/localhost\/api\/responseTag",
"request": {
"url": "http:\/\/localhost\/api\/responseTag",
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "formdata",
"formdata": []
},
"description": "",
"response": []
}
}
]
}
]
}
56 changes: 55 additions & 1 deletion tests/Fixtures/collection_updated_url.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1,55 @@
{"variables":[],"info":{"name":"Laravel API","_postman_id":"","description":"","schema":"https:\/\/schema.getpostman.com\/json\/collection\/v2.0.0\/collection.json"},"item":[{"name":"Group A","description":"","item":[{"name":"Example title.","request":{"url":"http:\/\/yourapp.app\/api\/test","method":"GET","body":{"mode":"formdata","formdata":[]},"description":"This will be the long description.\nIt can also be multiple lines long.","response":[]}},{"name":"http:\/\/yourapp.app\/api\/responseTag","request":{"url":"http:\/\/yourapp.app\/api\/responseTag","method":"POST","body":{"mode":"formdata","formdata":[]},"description":"","response":[]}}]}]}
{
"variables": [],
"info": {
"name": "Laravel API",
"_postman_id": "",
"description": "",
"schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.0.0\/collection.json"
},
"item": [
{
"name": "Group A",
"description": "",
"item": [
{
"name": "Example title.",
"request": {
"url": "http:\/\/yourapp.app\/api\/test",
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "formdata",
"formdata": []
},
"description": "This will be the long description.\nIt can also be multiple lines long.",
"response": []
}
},
{
"name": "http:\/\/yourapp.app\/api\/responseTag",
"request": {
"url": "http:\/\/yourapp.app\/api\/responseTag",
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "formdata",
"formdata": []
},
"description": "",
"response": []
}
}
]
}
]
}
109 changes: 109 additions & 0 deletions tests/Fixtures/collection_with_body_parameters.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
{
"variables": [],
"info": {
"name": "Laravel API",
"_postman_id": "",
"description": "",
"schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.0.0\/collection.json"
},
"item": [
{
"name": "Group A",
"description": "",
"item": [
{
"name": "http://localhost/api/withBodyParameters",
"request": {
"url": "http:\/\/localhost\/api\/withBodyParameters",
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "user_id",
"value": 9,
"type": "text",
"enabled": true
},
{
"key": "room_id",
"value": "consequatur",
"type": "text",
"enabled": true
},
{
"key": "forever",
"value": false,
"type": "text",
"enabled": true
},
{
"key": "another_one",
"value": 11613.31890586,
"type": "text",
"enabled": true
},
{
"key": "yet_another_param",
"value": [],
"type": "text",
"enabled": true
},
{
"key": "even_more_param",
"value": [],
"type": "text",
"enabled": true
},
{
"key": "book.name",
"value": "consequatur",
"type": "text",
"enabled": true
},
{
"key": "book.author_id",
"value": 17,
"type": "text",
"enabled": true
},
{
"key": "book[pages_count]",
"value": 17,
"type": "text",
"enabled": true
},
{
"key": "ids.*",
"value": 17,
"type": "text",
"enabled": true
},
{
"key": "users.*.first_name",
"value": "John",
"type": "text",
"enabled": true
},
{
"key": "users.*.last_name",
"value": "Doe",
"type": "text",
"enabled": true
}
]
},
"description": "",
"response": []
}
}
]
}
]
}
44 changes: 44 additions & 0 deletions tests/Fixtures/collection_with_custom_headers.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
{
"variables": [],
"info": {
"name": "Laravel API",
"_postman_id": "",
"description": "",
"schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.0.0\/collection.json"
},
"item": [
{
"name": "Group A",
"description": "",
"item": [
{
"name": "http://localhost/api/headers",
"request": {
"url": "http:\/\/localhost\/api\/headers",
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "customAuthToken"
},
{
"key": "Custom-Header",
"value": "NotSoCustom"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "formdata",
"formdata": []
},
"description": "",
"response": []
}
}
]
}
]
}
36 changes: 36 additions & 0 deletions tests/Fixtures/collection_with_query_parameters.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
{
"variables": [],
"info": {
"name": "Laravel API",
"_postman_id": "",
"description": "",
"schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.0.0\/collection.json"
},
"item": [
{
"name": "Group A",
"description": "",
"item": [
{
"name": "http://localhost/api/withQueryParameters",
"request": {
"url": "http:\/\/localhost\/api\/withQueryParameters?location_id=consequatur&user_id=me&page=4&filters=consequatur",
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "formdata",
"formdata": []
},
"description": "",
"response": []
}
}
]
}
]
}
Loading

0 comments on commit 573e9ef

Please sign in to comment.