Swagger #469
Swagger #469
Conversation
…nvert it to a Swagger specification; newly supports path and query parameters
… now delete the temp file
…nvert it to a Swagger specification; newly supports path and query parameters
… now delete the temp file
app/commands/GenerateSwagger.php
Outdated
| $path = __DIR__ . '/../V1Module/presenters/_autogenerated_annotations_temp.php'; | ||
| $openapi = \OpenApi\Generator::scan([$path]); | ||
|
|
||
| header('Content-Type: application/x-yaml'); |
There was a problem hiding this comment.
What is the purpose of setting a header here?
|
|
||
| protected function execute(InputInterface $input, OutputInterface $output) | ||
| { | ||
| $path = __DIR__ . '/../V1Module/presenters/_autogenerated_annotations_temp.php'; |
There was a problem hiding this comment.
Generated files are usually in temp. If there is any exception, it needs to be duly explained in a comment.
| // $entry["tags"] = array_unique($entry["tags"]); | ||
| // } | ||
| // } | ||
| class GenerateSwagger extends Command |
There was a problem hiding this comment.
The class doc comment is missing.
| use ReflectionException; | ||
| use ReflectionClass; | ||
|
|
||
| class SwaggerAnnotator extends Command |
There was a problem hiding this comment.
The class doc comment is missing.
| $tokens = explode(" ", $annotation); | ||
| $type = $tokens[1]; | ||
| // assumed that all names start with $ | ||
| $name = substr($tokens[2], 1); |
There was a problem hiding this comment.
It is better to use destructive assignments like [$_, $type, $name] = $tokens. (but this comment has low priority)
| // remove the '"' at the end | ||
| $value = substr($tokens[1], 0, -1); | ||
| $dict[$name] = $value; | ||
| } |
There was a problem hiding this comment.
This is getting increasingly complex. Wouldn't it be more readable to extract the name-value pair using regex?
| // sample: @checked_param format:group group | ||
| $tokens = explode(" ", $annotation); | ||
| $format = $tokens[1]; | ||
| $name = $tokens[2]; |
There was a problem hiding this comment.
Again, opportunity for destructive assignment.
| return true; | ||
| } | ||
|
|
||
| return false; |
There was a problem hiding this comment.
This looks a bit like an overkill (the whole function can be one && bool expr). If this might extend in the future, then it is ok, I guess, otherwise, compacting should be considered.
Added a new command
generate-swaggerthat prints a swagger document representing the current API to the console.