Laravel-apidoc-generator 无法自动生成带参数的 API 文档
控制器内容如下
<?php
namespace App\Http\Controllers\platform;
//use Illuminate\Http\Request;
use App\Http\Requests\AuthRequest;
use App\Http\Controllers\Controller;
use Auth;
class SessionsController extends Controller
{
/**
* 用户登录(平台用户登陆)
* @param AuthRequest $request
*/
public function store(AuthRequest $request)
{
$credentials = array(
'email' => $request->email,
'password' => $request->password,
);
if (Auth::guard('platformAdmin')->attempt($credentials)){
//登录成功
return Auth::guard('platformAdmin')->user();
} else {
//登录失败
return '登录失败';
}
}
}
请求类文件如下:
<?php
namespace App\Http\Requests;
use Illuminate\Foundation\Http\FormRequest;
class AuthRequest extends FormRequest
{
/**
* Determine if the user is authorized to make this request.
*
* @return bool
*/
public function authorize()
{
return true;
}
/**
* Get the validation rules that apply to the request.
*
* @return array
*/
public function rules()
{
return [
'email' => ['required', 'email', 'max:255'],
'password' => ['required'],
];
}
public function attributes()
{
return [
'email' => '邮箱',
'password' => '密码',
];
}
public function messages()
{
return [
'email.required'=>'请填写邮箱',
'email.email'=>'邮箱格式错误',
'password.required' => '密码不能为空'
];
}
}
但是生成的文档没有参数说明,请赐教
本作品采用《CC 协议》,转载必须注明作者和本文链接
推荐文章: