Merge pull request #14 from AndreasElia/feature/populated-form-data

Populate formdata based on request classes

README.md

@@ -32,6 +32,8 @@ You can modify the `api-postman.php` config values:
 - `structured` - If you want folders to be generated based on route names.
 - `base_url` - The base URL for all of your endpoints.
 - `auth_middleware` - The middleware which wraps your authenticated API routes.
+- `enable_formdata` - Determines whether or not form data should be handled.
+- `formdata` - The key/values to requests for form data dummy information.
 
 ## Usage
 

config/api-postman.php

@@ -45,4 +45,23 @@
  ],
  ],
 
+ /*
+ * Enable Form Data.
+ *
+ * Determines whether or not form data should be handled.
+ */
+
+ 'enable_formdata' => false,
+
+ /*
+ * Form Data.
+ *
+ * The key/values to requests for form data dummy information.
+ */
+
+ 'formdata' => [
+ // 'email' => '[email protected]',
+ // 'password' => 'changeme',
+ ],
+
 ];

src/ExportPostman.php

@@ -2,10 +2,14 @@
 
 namespace AndreasElia\PostmanGenerator;
 
+use Closure;
 use Illuminate\Console\Command;
 use Illuminate\Contracts\Config\Repository;
+use Illuminate\Foundation\Http\FormRequest;
 use Illuminate\Routing\Router;
 use Illuminate\Support\Facades\Storage;
+use ReflectionClass;
+use ReflectionFunction;
 
 class ExportPostman extends Command
 {
@@ -40,8 +44,6 @@ public function handle(): void
 
  $this->initStructure($filename);
 
- $structured = $this->config['structured'];
-
  if ($bearer) {
  $this->structure['variable'][] = [
  'key' => 'token',
@@ -57,6 +59,33 @@ public function handle(): void
  continue;
  }
 
+ $requestRules = [];
+
+ if ($this->config['enable_formdata']) {
+ $routeAction = $route->getAction();
+
+ if ($routeAction['uses'] instanceof Closure) {
+ $reflectionMethod = new ReflectionFunction($routeAction['uses']);
+ } else {
+ $routeData = explode('@', $routeAction['uses']);
+ $reflection = new ReflectionClass($routeData[0]);
+ $reflectionMethod = $reflection->getMethod($routeData[1]);
+ }
+
+ $firstParameter = $reflectionMethod->getParameters()[0] ?? false;
+
+ if ($firstParameter) {
+ $requestClass = $firstParameter->getType()->getName();
+ $requestClass = new $requestClass();
+
+ if ($requestClass instanceof FormRequest) {
+ $requestRules = $requestClass->rules();
+
+ $requestRules = array_keys($requestRules);
+ }
+ }
+ }
+
  $routeHeaders = $this->config['headers'];
 
  if ($bearer && in_array($this->config['auth_middleware'], $middleware)) {
@@ -66,13 +95,9 @@ public function handle(): void
  ];
  }
 
- $request = $this->makeItem($route, $method, $routeHeaders);
+ $request = $this->makeItem($route, $method, $routeHeaders, $requestRules);
 
- if (! $structured) {
- $this->structure['item'][] = $request;
- }
-
- if ($structured) {
+ if ($this->config['structured']) {
  $routeNames = $route->action['as'] ?? null;
 
  if (! $routeNames) {
@@ -92,6 +117,8 @@ public function handle(): void
  $destination = end($routeNames);
 
  $this->ensurePath($this->structure, $routeNames, $request, $destination);
+ } else {
+ $this->structure['item'][] = $request;
  }
  }
  }
@@ -138,9 +165,9 @@ protected function ensurePath(array &$routes, array $segments, array $request, s
  }
  }
 
- public function makeItem($route, $method, $routeHeaders)
+ public function makeItem($route, $method, $routeHeaders, $requestRules)
  {
- return  [
+ $data = [
  'name' => $route->uri(),
  'request' => [
  'method' => strtoupper($method),
@@ -151,6 +178,25 @@ public function makeItem($route, $method, $routeHeaders)
  ],
  ],
  ];
+
+ if ($requestRules) {
+ $ruleData = [];
+
+ foreach ($requestRules as $rule) {
+ $ruleData[] = [
+ 'key' => $rule,
+ 'value' => $this->config['formdata'][$rule] ?? null,
+ 'type' => 'text',
+ ];
+ }
+
+ $data['request']['body'] = [
+ 'mode' => 'urlencoded',
+ 'urlencoded' => $ruleData,
+ ];
+ }
+
+ return $data;
  }
 
  protected function initStructure(string $filename): void