PHP code example of php-openapi / yii2-openapi

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

php-openapi / yii2-openapi example snippets

$config = [
    // ... this is your application config ...
];

if (YII_ENV_DEV) {
    // enable Gii module
    $config['bootstrap'][] = 'gii';
    $config['modules']['gii'] = [
        'class' => \yii\gii\Module::class,
        'generators' => [
            // add ApiGenerator to Gii module
            'api' => \cebe\yii2openapi\generator\ApiGenerator::class,

            // --------- OR ---------
            // to disable generation of migrations files or with default config change
            'api' => [
              'class' => \cebe\yii2openapi\generator\ApiGenerator::class,
              'generateMigrations' => false, # this config can also be applied in CLI command
            ],
        ],
    ];
}

return $config;

    abstract class Invoice extends \yii\db\ActiveRecord
    {
        /**
         * Scenario create
         */
        public const SCENARIO_CREATE = 'create';

        /**
         * Scenario update
         */
        public const SCENARIO_UPDATE = 'update';

        /**
         * Automatically generated scenarios from the model 'x-scenarios'.
         * @return array a list of scenarios and the corresponding active attributes.
         */
        public function scenarios()
        {
            $parentScenarios = parent::scenarios();

            /**
             * Each scenario is assigned attributes as in the 'default' scenario.
             * The advantage is that the scenario can be used immediately.
             * This can be overridden in the child model if needed.
             */
            $default = $parentScenarios[self::SCENARIO_DEFAULT];

            return [
               self::SCENARIO_CREATE => $default,
               self::SCENARIO_UPDATE => $default,
               /**
                * The 'default' scenario and all scenarios mentioned in the rules() using 'on' and 'except'
                * are automatically 

    abstract class Invoice extends \yii\db\ActiveRecord
    {
        /**
         * My custom description for scenario create
         */
        public const SCENARIO_CREATE = 'create';

        /**
         * Scenario update
         */
        public const SCENARIO_UPDATE = 'update';

        /**
         * Automatically generated scenarios from the model 'x-scenarios'.
         * @return array a list of scenarios and the corresponding active attributes.
         */
        public function scenarios()
        {...}
      }
      

    $config['modules']['gii']['generators']['api'] = [
        'class' => \cebe\yii2openapi\generator\ApiGenerator::class,
        'dbModel' => [
            /** Accepted-Placeholder: {scenarioName}, {scenarioConst}, {modelName}. @see DbModel::$scenarioDefaultDescription */
            'scenarioDefaultDescription' => "This scenario \"{scenarioName}\" at Model \"{modelName}\" has Constant {scenarioConst}.",
        ],
        ...
    ];
    

    abstract class Invoice extends \yii\db\ActiveRecord
    {
        /**
         * My custom description for scenario create
         */
        public const SCENARIO_CREATE = 'create';

        /**
         * This scenario "update" at Model "Invoice" has Constant SCENARIO_UPDATE.
         */
        public const SCENARIO_UPDATE = 'update';

        /**
         * Automatically generated scenarios from the model 'x-scenarios'.
         * @return array a list of scenarios and the corresponding active attributes.
         */
        public function scenarios()
        {...}
      }
      

    $config['modules']['gii']['generators']['api'] = [
        'class' => \cebe\yii2openapi\generator\ApiGenerator::class,
        'dbModel' => [
            /** Accepted-Placeholder: {scenarioName}, {scenarioConst}, {modelName}. @see DbModel::$scenarioDefaultDescription */
            'scenarioDefaultDescription' => implode("\n", [
                "This Backend-Scenario \"{scenarioName}\" exist in both the frontend model and the backend model.",
                "@see \common\client\models\{modelName}::{scenarioConst}",
            ]),
        ],
        ...
    ];

   $config['modules']['gii']['generators']['api-client'] = [
       'class' => \common\client_generator\{your_ApiClientGenerator}::class,
       'dbModel' => [
           /** AcceptedInputs: {scenarioName}, {scenarioConst}, {modelName}. @see DbModel::$scenarioDefaultDescription */
           'scenarioDefaultDescription' => implode("\n", [
               "This Frontend-Scenario \"{scenarioName}\" exist in both the frontend model and the backend model.",
               "@see \common\models\base\{modelName}::{scenarioConst}",
           ]),
       ],
       ...
    

    abstract class Invoice extends \yii\db\ActiveRecord
    {
        /**
         * This Backend-Scenario "create" exist in both the frontend model and the backend model.
         * @see \common\client\models\Invoice::SCENARIO_CREATE
         */
        public const SCENARIO_CREATE = 'create';

        /**
         * This Backend-Scenario "update" exist in both the frontend model and the backend model.
         * @see \common\client\models\Invoice::SCENARIO_UPDATE
         */
        public const SCENARIO_UPDATE = 'update';

        /**
         * Automatically generated scenarios from the model 'x-scenarios'.
         * @return array a list of scenarios and the corresponding active attributes.
         */
        public function scenarios()
        {...}
    }
    

    'POST payments/invoice/<invoice:\d+>' => 'payments/invoice',
    'payments/invoice/<invoice:\d+>' => 'payments/options',

    'GET a1/b1' => 'abc/xyz',
    'POST a1/b1' => 'abc/xyz',
    'a1/b1' => 'abc/options',

$this->addColumn('{{%company}}', 'name', $this->string(128)->notNull());

$this->addColumn('{{%company}}', 'name', $this->string(128)->null());
$this->update('{{%company}}', ['name' => 'No name']);
$this->alterColumn('{{%company}}', 'name', $this->string(128)->notNull());

yaml
        comments:
          type: array
          items:
            $ref: "#/components/schemas/Comment"

Post:
  properties:
  ...
    tags:
      type: array
      items:
        $ref: '#/components/schemas/Tag'

Tag:
  properties:
  ...
    posts:
      type: array
      items:
        $ref: '#/components/schemas/Post'