Add swagger:make-schema-builder command

Author: Mezatsong

src/Commands/MakeSwaggerSchemaBuilder.php

@@ -0,0 +1,63 @@
+<?php namespace Mezatsong\SwaggerDocs\Commands;
+
+use Illuminate\Console\GeneratorCommand;
+use Symfony\Component\Console\Input\InputArgument;
+
+/**
+ * Class MakeSwaggerSchemaBuilder
+ * @package Mezatsong\SwaggerDocs\Commands
+ */
+class MakeSwaggerSchemaBuilder extends GeneratorCommand {
+
+    /**
+     * The console command name.
+     *
+     * @var string
+     */
+    protected $name = 'swagger:make-schema-builder';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Create a new Swagger schema builder';
+
+    /**
+     * The type of class being generated.
+     *
+     * @var string
+     */
+    protected $type = 'SchemaBuilder';
+
+    /**
+     * @inheritDoc
+     */
+    protected function getStub()
+    {
+        return __DIR__ . '/../stubs/SchemaBuilder.stub';
+    }
+
+    /**
+     * Get the console command arguments.
+     *
+     * @return array
+     */
+    protected function getArguments()
+    {
+        return [
+            ['name', InputArgument::REQUIRED, 'The name of the class to be generated'],
+        ];
+    }
+
+    /**
+     * Get the default namespace for the class.
+     *
+     * @param string $rootNamespace
+     * @return string
+     */
+    protected function getDefaultNamespace($rootNamespace)
+    {
+        return $rootNamespace.'\Swagger\SchemaBuilders';
+    }
+}

src/Responses/SchemaBuilder.php

@@ -9,7 +9,7 @@ interface SchemaBuilder {
     /**
      * Build and return a custom swagger schema
      * @param string $modelRef a model swagger ref, (ex: #/components/schemas/User)
-     * @param stirng $uri a current parsing uri
+     * @param string $uri a current parsing uri
      * @return array an associative array representing the swagger schema for this resposne
      */
     public function build(string $modelRef, string $uri): array;

src/Responses/SchemaBuilders/LaravelPaginateSchemaBuilder.php

@@ -11,6 +11,9 @@ class LaravelPaginateSchemaBuilder implements SchemaBuilder {
 
     /**
      * Build a schema for Laravel pagination
+     *
+     * @param string $modelRef the swagger reference for model
+     * @param string $uri the current parsing uri
      * @return array
      */
     public function build(string $modelRef, string $uri): array {

src/Responses/SchemaBuilders/LaravelSimplePaginateSchemaBuilder.php

@@ -12,6 +12,9 @@ class LaravelSimplePaginateSchemaBuilder implements SchemaBuilder {
 
     /**
      * Build a schema for Laravel simple pagination
+     *
+     * @param string $modelRef the swagger reference for model
+     * @param string $uri the current parsing uri
      * @return array
      */
     public function build(string $modelRef, string $uri): array {

src/SwaggerServiceProvider.php

@@ -5,6 +5,7 @@
 use Illuminate\Support\Facades\Validator;
 use Illuminate\Support\ServiceProvider;
 use Mezatsong\SwaggerDocs\Commands\GenerateSwaggerDocumentation;
+use Mezatsong\SwaggerDocs\Commands\MakeSwaggerSchemaBuilder;
 
 /**
  * Class SwaggerServiceProvider
@@ -19,7 +20,8 @@ class SwaggerServiceProvider extends ServiceProvider {
     public function boot(): void {
         if ($this->app->runningInConsole()) {
             $this->commands([
-                GenerateSwaggerDocumentation::class
+                GenerateSwaggerDocumentation::class,
+                MakeSwaggerSchemaBuilder::class
             ]);
         }
 

src/stubs/SchemaBuilder.stub

@@ -0,0 +1,91 @@
+<?php
+
+namespace DummyNamespace;
+
+use Illuminate\Support\Str;
+use Mezatsong\SwaggerDocs\Responses\SchemaBuilder;
+
+class DummyClass implements SchemaBuilder
+{
+
+    /**
+     * Build and return a custom swagger schema
+     * Here is an example with Laravel pagination
+     *
+     * @param string $modelRef a model swagger ref, (ex: #/components/schemas/User)
+     * @param string $uri a current parsing uri
+     * @return array an associative array representing the swagger schema for this resposne
+     */
+    public function build(string $modelRef, string $uri): array {
+        if (!Str::startsWith($uri, '/')) {
+            $uri = '/' . $uri;
+        }
+        $url = env('APP_URL') . $uri;
+        return [
+            'type' => 'object',
+            'required' => [
+                'current_page',
+                'data',
+                'first_page_url',
+                'last_page',
+                'last_page_url',
+                'path',
+                'per_page',
+                'total'
+            ],
+            'properties' => [
+                "current_page" => [
+                    'type' => 'integer',
+                    'example' => 2
+                ],
+                "data" => [
+                    'type' => 'array',
+                    'items' => [
+                        'type' => 'object',
+                        '$ref' => $modelRef
+                    ]
+                ],
+                "first_page_url" => [
+                    'type' => 'string',
+                    'example' => "$url?page=1"
+                ],
+                "from" => [
+                    'type' => 'integer',
+                    'example' => 16
+                ],
+                "last_page" => [
+                    'type' => 'integer',
+                    'example' => 10
+                ],
+                "last_page_url" => [
+                    'type' => 'string',
+                    'example' => "$url?page=10"
+                ],
+                "next_page_url" => [
+                    'type' => 'string',
+                    'example' => "$url?page=3"
+                ],
+                "path" => [
+                    'type' => 'string',
+                    'example' => "$url"
+                ],
+                "per_page" => [
+                    'type' => 'integer',
+                    'example' => 15
+                ],
+                "prev_page_url" => [
+                    'type' => 'string',
+                    'example' => "$url?page=1"
+                ],
+                "to" => [
+                    'type' => 'integer',
+                    'example' => 30
+                ],
+                "total" => [
+                    'type' => 'integer',
+                    'example' => 150
+                ],
+            ]
+        ];
+    }
+}