WIP api generator

Author: cebe

.gitignore

@@ -3,3 +3,5 @@
 /*/*.pid
 /*/*.log
 session_mm_*.sem
+
+/env.php

README.md

@@ -4,18 +4,59 @@
 
 Yii Framework Application Template for quickly building API-first applications.
 
+## Overview
+
+This application template consists of 3 application tiers:
+
+- `api`, contains the Yii application for the REST API.
+- `console`, contains the Yii application for console commands, cronjobs or queues.
+- `backend`, contains the Yii application for a CRUD backend on the API data.
+
+
 ## Setup
 
     git clone https://github.com/cebe/yii2-app-api my-api
     cd my-api
+    cp env.php.dist env.php
     composer install
 
-## Overview
+## Generate Code
 
-This application consists of 3 parts:
+### Console
 
-- `api`, contains the Yii application for the REST API.
-- `console`, contains the Yii application for console commands, cronjobs or queues.
-- `backend`, contains the Yii application for a CRUD backend on the API data.
+Run `./yii gii/api` to generate your API code. The `--openApiPath` parameter specifies the path to your OpenAPI
+spec file. The following example will generate API code for the [OpenAPI petstore example](https://github.com/OAI/OpenAPI-Specification/blob/3.0.2/examples/v3.0/petstore-expanded.yaml).
+
+    ./yii gii/api --openApiPath=https://raw.githubusercontent.com/OAI/OpenAPI-Specification/3.0.2/examples/v3.0/petstore-expanded.yaml
+
+Run `./yii gii/api --help` for a list of configuration options. You may also adjust the configuration in `config/gii-generators.php`.
+
+Then set up the database:
+
+    ./yii migrate/up
+    ./yii faker
+
+### Web
+
+To use the web generator, start the backend server:
+
+    cd backend
+    make start
+
+open `http://localhost:8338/gii` and select the `REST API Generator`.
+
+![Gii - REST API Generator](docs/img/gii-generator.png)
+
+Enter the path or URL to the "OpenAPI 3 Spec file", e.g. `https://raw.githubusercontent.com/OAI/OpenAPI-Specification/3.0.2/examples/v3.0/petstore-expanded.yaml`.
+
+Click "Preview":
+
+![Gii - REST API Generator - Generated files](docs/img/gii-generator-files.png)
+
+Click "Generate" to generate API files.
+
+Then set up the database by running the following commands on the command line:
 
+    ./yii migrate/up
+    ./yii faker
 

api/config/url-rules.php

@@ -1,15 +1,10 @@
 <?php
 
-// TODO configure URL rules with autogenerated spec rules
-
-return [
-    '' => 'home/index',
-    [
-        'class' => yii\rest\UrlRule::class,
-        'controller' => ['home'],
-        'pluralize' => false,
-        'extraPatterns' => [
-            'GET index' => 'index'
-        ]
-    ]
+$customRules = [
+    // add your custom URL rules here
 ];
+
+if (file_exists(__DIR__ . '/url-rules.rest.php')) {
+    return array_merge(require __DIR__ . '/url-rules.rest.php', $customRules);
+}
+return $customRules;

backend/config/app-dev.php

@@ -18,10 +18,8 @@
 $config['bootstrap'][] = 'gii';
 $config['modules']['gii'] = [
     'class' => yii\gii\Module::class,
-    'generators' => [
-        // add ApiGenerator to Gii module
-        'api' => \cebe\yii2openapi\generator\ApiGenerator::class,
-    ],
+    // add ApiGenerator to Gii module
+    'generators' => require __DIR__ . '/../../config/gii-generators.php',
 ];
 
 return $config;

composer.json

@@ -1,4 +1,5 @@
 {
+    "name": "cebe/yii2-app-api",
     "require": {
         "php": ">=7.1.0",
         "yiisoft/yii2": "~2.0.16",