Skip to content

#49:- update description generating logic; #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Aug 8, 2022
Merged

#49:- update description generating logic; #52

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
7283f5b
feat: update description generating logic;
pirs1337 Jul 16, 2022
335a5f7
refactor: refactoring to remove useless keys;
pirs1337 Jul 18, 2022
8bc987d
chore: renaming rulesOfTypes property;
pirs1337 Jul 19, 2022
6244a5a
fix: fix description logic;
pirs1337 Jul 29, 2022
7d77ea6
fix: fix description logic;
pirs1337 Jul 29, 2022
e035b08
fix: fix description logic;
pirs1337 Jul 29, 2022
94d2d1c
fix: fix description logic;
pirs1337 Jul 29, 2022
fc19e94
chore: adding type for function parameter
pirs1337 Jul 30, 2022
75be84d
fix: replacing method;
pirs1337 Aug 6, 2022
3022100
Merge branch 'master' of https://github.com/RonasIT/laravel-swagger i…
pirs1337 Aug 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 39 additions & 20 deletions src/Services/SwaggerService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,16 @@ class SwaggerService
private $item;
private $security;

protected $rulesOfTypes = [
'array' => 'object',
'boolean' => 'boolean',
'date' => 'date',
'digits' => 'integer',
'integer' => 'integer',
'numeric' => 'double',
'string' => 'string'
];

public function __construct(Container $container)
{
$this->initConfig();
Expand Down Expand Up @@ -313,22 +323,27 @@ protected function saveParameters($request, array $annotations)
$formRequest->setUserResolver($this->request->getUserResolver());
$formRequest->setRouteResolver($this->request->getRouteResolver());
$rules = method_exists($formRequest, 'rules') ? $formRequest->rules() : [];
$attributes = method_exists($formRequest, 'attributes') ? $formRequest->attributes() : [];

$actionName = $this->getActionName($this->uri);

if (in_array($this->method, ['get', 'delete'])) {
$this->saveGetRequestParameters($rules, $annotations);
$this->saveGetRequestParameters($rules, $attributes, $annotations);
} else {
$this->savePostRequestParameters($actionName, $rules, $annotations);
$this->savePostRequestParameters($actionName, $rules, $attributes, $annotations);
}
}

protected function saveGetRequestParameters($rules, array $annotations)
protected function saveGetRequestParameters($rules, array $attributes, array $annotations)
{
foreach ($rules as $parameter => $rule) {
$validation = explode('|', $rule);

$description = Arr::get($annotations, $parameter, implode(', ', $validation));
$description = Arr::get($annotations, $parameter);

if (empty($description)) {
$description = Arr::get($attributes, $parameter, implode(', ', $validation));
}

$existedParameter = Arr::first($this->item['parameters'], function ($existedParameter) use ($parameter) {
return $existedParameter['name'] == $parameter;
Expand All @@ -350,7 +365,7 @@ protected function saveGetRequestParameters($rules, array $annotations)
}
}

protected function savePostRequestParameters($actionName, $rules, array $annotations)
protected function savePostRequestParameters($actionName, $rules, array $attributes, array $annotations)
{
if ($this->requestHasMoreProperties($actionName)) {
if ($this->requestHasBody()) {
Expand All @@ -365,25 +380,32 @@ protected function savePostRequestParameters($actionName, $rules, array $annotat
];
}

$this->saveDefinitions($actionName, $rules, $annotations);
$this->saveDefinitions($actionName, $rules, $attributes, $annotations);
}
}

protected function saveDefinitions($objectName, $rules, array $annotations)
protected function saveDefinitions($objectName, $rules, $attributes, array $annotations)
{
$data = [
'type' => 'object',
'properties' => []
];

foreach ($rules as $parameter => $rule) {
$rulesArray = (is_array($rule)) ? $rule : explode('|', $rule);
$parameterType = $this->getParameterType($rulesArray);
$this->saveParameterType($data, $parameter, $parameterType);
$this->saveParameterDescription($data, $parameter, $rulesArray, $annotations);

$uselessRules = $this->rulesOfTypes;
$uselessRules['required'] = 'required';

if (in_array('required', $rulesArray)) {
$data['required'][] = $parameter;
}

$rulesArray = array_diff_key(array_flip($rulesArray), $uselessRules);

$this->saveParameterDescription($data, $parameter, $rulesArray, $attributes, $annotations);
}

$data['example'] = $this->generateExample($data['properties']);
Expand All @@ -392,16 +414,8 @@ protected function saveDefinitions($objectName, $rules, array $annotations)

protected function getParameterType(array $validation): string
{
$validationRules = [
'array' => 'object',
'boolean' => 'boolean',
'date' => 'date',
'digits' => 'integer',
'email' => 'string',
'integer' => 'integer',
'numeric' => 'double',
'string' => 'string'
];
$validationRules = $this->rulesOfTypes;
$validationRules['email'] = 'string';

$parameterType = 'string';

Expand All @@ -421,9 +435,14 @@ protected function saveParameterType(&$data, $parameter, $parameterType)
];
}

protected function saveParameterDescription(&$data, $parameter, array $rulesArray, array $annotations)
protected function saveParameterDescription(&$data, $parameter, array $rulesArray, array $attributes, array $annotations)
{
$description = Arr::get($annotations, $parameter, implode(', ', $rulesArray));
$description = Arr::get($annotations, $parameter);

if (empty($description)) {
$description = Arr::get($attributes, $parameter, implode(', ', $rulesArray));
}

$data['properties'][$parameter]['description'] = $description;
}

Expand Down