README

安装

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

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

]

控制器

@apiParam 类型 名称: 描述

特殊类型

• array, object - json-editor

class Controller extends BaseController {

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

资源

@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)
    {
        ////
    }
}