* * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ declare(strict_types=1); namespace ApiPlatform\JsonSchema\Command; use ApiPlatform\Core\Api\OperationType; use ApiPlatform\Core\JsonSchema\SchemaFactoryInterface as LegacySchemaFactoryInterface; use ApiPlatform\JsonSchema\Schema; use ApiPlatform\JsonSchema\SchemaFactoryInterface; use ApiPlatform\Metadata\HttpOperation; use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Exception\InvalidOptionException; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Console\Style\SymfonyStyle; /** * Generates a resource JSON Schema. * * @author Jacques Lefebvre */ final class JsonSchemaGenerateCommand extends Command { /** * @var SchemaFactoryInterface|LegacySchemaFactoryInterface */ private $schemaFactory; private $formats; public function __construct($schemaFactory, array $formats) { $this->schemaFactory = $schemaFactory; $this->formats = array_keys($formats); parent::__construct(); } /** * {@inheritdoc} */ protected function configure() { $this ->setDescription('Generates the JSON Schema for a resource operation.') ->addArgument('resource', InputArgument::REQUIRED, 'The Fully Qualified Class Name (FQCN) of the resource') ->addOption('itemOperation', null, InputOption::VALUE_REQUIRED, 'The item operation') ->addOption('collectionOperation', null, InputOption::VALUE_REQUIRED, 'The collection operation') ->addOption('format', null, InputOption::VALUE_REQUIRED, 'The response format', (string) $this->formats[0]) ->addOption('type', null, InputOption::VALUE_REQUIRED, sprintf('The type of schema to generate (%s or %s)', Schema::TYPE_INPUT, Schema::TYPE_OUTPUT), Schema::TYPE_INPUT); } /** * {@inheritdoc} */ protected function execute(InputInterface $input, OutputInterface $output): int { $io = new SymfonyStyle($input, $output); /** @var string $resource */ $resource = $input->getArgument('resource'); /** @var ?string $itemOperation */ $itemOperation = $input->getOption('itemOperation'); /** @var ?string $collectionOperation */ $collectionOperation = $input->getOption('collectionOperation'); /** @var string $format */ $format = $input->getOption('format'); /** @var string $type */ $type = $input->getOption('type'); if (!\in_array($type, [Schema::TYPE_INPUT, Schema::TYPE_OUTPUT], true)) { $io->error(sprintf('You can only use "%s" or "%s" for the "type" option', Schema::TYPE_INPUT, Schema::TYPE_OUTPUT)); return 1; } if (!\in_array($format, $this->formats, true)) { throw new InvalidOptionException(sprintf('The response format "%s" is not supported. Supported formats are : %s.', $format, implode(', ', $this->formats))); } /** @var ?string $operationType */ $operationType = null; /** @var ?string $operationName */ $operationName = null; if ($itemOperation && $collectionOperation) { $io->error('You can only use one of "--itemOperation" and "--collectionOperation" options at the same time.'); return 1; } if (null !== $itemOperation || null !== $collectionOperation) { $operationType = $itemOperation ? OperationType::ITEM : OperationType::COLLECTION; $operationName = $itemOperation ?? $collectionOperation; } if ($this->schemaFactory instanceof LegacySchemaFactoryInterface) { $schema = $this->schemaFactory->buildSchema($resource, $format, $type, $operationType, $operationName); } else { $schema = $this->schemaFactory->buildSchema($resource, $format, $type, $operationName ? (new class() extends HttpOperation {})->withName($operationName) : null); } if (null !== $operationType && null !== $operationName && !$schema->isDefined()) { $io->error(sprintf('There is no %s defined for the operation "%s" of the resource "%s".', $type, $operationName, $resource)); return 1; } $io->text((string) json_encode($schema, \JSON_PRETTY_PRINT | \JSON_UNESCAPED_SLASHES)); return 0; } public static function getDefaultName(): string { return 'api:json-schema:generate'; } } class_alias(JsonSchemaGenerateCommand::class, \ApiPlatform\Core\JsonSchema\Command\JsonSchemaGenerateCommand::class);