pk-engine/apidoc

ApiDoc for Crud

v2.2 2023-07-19 04:59 UTC

Requires

• php: >=7.4
• laravel/framework: ^8.37|^9.0
• phpdocumentor/reflection-docblock: ^5.3

MIT

• Evgeny Kylin

README

Установка

composer require --dev pk-engine/apidoc
php artisan vendor:publish --provider="PkEngine\Apidoc\ApidocServiceProvider"

'providers' => [
  
   PkEngine\Apidoc\ApidocServiceProvider::class,

]

Controller

@apiParam тип название: описание

Исключительне типы:

• array, object - json-editor

class Controller extends BaseController {

    /**
    * @apiParam string foo: bar
    * 
    * @param Request $request
    * @return void
     */
    public function index(Request $request)
    {
        ///
    }
    
}

Resource

@field тип название: описание

Исключительне типы:

• #название - ссылка на ресурс модели

class Resource extends JsonResource
{
    /**
     * Transform the resource into an array.
     * @field #model foo: bar
     * @field int id: ID
     *
     * @param  \Illuminate\Http\Request  $request
     * @return array|\Illuminate\Contracts\Support\Arrayable|\JsonSerializable
     */
    public function toArray($request)
    {
        ////
    }
}