RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-02 23:59:26 +03:00
Code Issues Projects Releases Wiki Activity

Updated SwaggerDocblockConvertCommand command in UPGRADE-3.0.md

Browse Source 
- Allowed null input in `escapeQuotes(string $str)` - description of an API can be null
- Added command option `views` to input comma separated list of views - the API can have view(s) other than `default`
This commit is contained in:
anawaz 2018-03-19 13:24:55 +01:00
parent 3698daa547
commit 7b62443417
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
UPGRADE-3.0.md
View File

@ -20,6 +20,7 @@ namespace AppBundle\Command;
use Nelmio\ApiDocBundle\Annotation\ApiDoc; use Nelmio\ApiDocBundle\Annotation\ApiDoc;
use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand; use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Console\Output\OutputInterface;
/** /**
@ -35,13 +36,20 @@ class SwaggerDocblockConvertCommand extends ContainerAwareCommand
$this $this
->setDescription('') ->setDescription('')
->setName('api:doc:convert') ->setName('api:doc:convert')
->addOption('views', null, InputOption::VALUE_OPTIONAL, 'Comma separated list of views to convert the documentation for', 'default')
; ;
} }
protected function execute(InputInterface $input, OutputInterface $output) protected function execute(InputInterface $input, OutputInterface $output)
{ {
$views = explode(',', $input->getOption('views'));
$extractor = $this->getContainer()->get('nelmio_api_doc.extractor.api_doc_extractor'); $extractor = $this->getContainer()->get('nelmio_api_doc.extractor.api_doc_extractor');
$apiDocs = $extractor->extractAnnotations($extractor->getRoutes());
$apiDocs = [];
foreach ($views as $view) {
$apiDocs = array_merge($apiDocs, $extractor->extractAnnotations($extractor->getRoutes(), $view));
}
foreach ($apiDocs as $annotation) { foreach ($apiDocs as $annotation) {
/** @var ApiDoc $apiDoc */ /** @var ApiDoc $apiDoc */
@ -175,8 +183,11 @@ class SwaggerDocblockConvertCommand extends ContainerAwareCommand
]; ];
} }
private function escapeQuotes(string $str): string private function escapeQuotes(string $str = null): string
{ {
if ($str === null) {
return '';
}
$lines = []; $lines = [];
foreach (explode("\n", $str) as $line) { foreach (explode("\n", $str) as $line) {
$lines[] = trim($line, ' *'); $lines[] = trim($line, ' *');