如何用招摇包裹Laravel资源

Question

我正在学习如何用招摇使用laravel，我有一个问题：

我有用户控制器：

usercontroller.php

class UserController extends Controller
{
    /**
     * Shows authenticated user information
     * 
     * @OA\Get(
     *     tags={"Authorize"},
     *     path="/user",
     *     summary="get user detail",
     *     security={{ "AuthBearer":{} }},
     *     @OA\Response(
     *          response="200", 
     *          description="success",
     *          @OA\JsonContent(
     *              ref="#/components/schemas/UserResource"
     *          )
     *      ),
     *     @OA\Response(response="401", description="Unauthenticated")
     * )
     *     
     * @return \Illuminate\Http\Response
     */  
    public function user()
    {                
        return new UserResource(auth()->user());
    }
}

userresource.php，

/**
 * Class UserResource
 * 
 * @OA\Schema(
 *  @OA\Xml(name="UserResource")
 * )
 */
class UserResource extends JsonResource
{
    /**
     * Transform the resource into an array.
     * 
     * @OA\Property(format="int64", title="ID", default=1, description="ID", property="id"),
     * @OA\Property(format="string", title="name", default="Demo", description="Name", property="name"),
     * @OA\Property(format="string", title="username", default="demo", description="Username", property="username"),
     * @OA\Property(format="string", title="avatar_path", default="https://via.placeholder.com/640x480.png/0000bb?text=avatar", description="Avatar Path", property="avatar_path")
     *
     * @param  \Illuminate\Http\Request  $request
     * @return array
     */
    public function toArray($request)
    {        
        return [
            'id' => $this->id,
            'name' => $this->name,
            'username' => $this->username,
            'avatar_path' => $this->avatar_path            
        ];
    }
}

这很好，但是在Swagger文档中，此路线的示例值是这样的：

{
  "id": 1,
  "name": "demo",
  "username": "demo",
  "avatar_path": "https://via.placeholder.com/640x480.png/0000bb?text=avatar"
}

但是当我以夸张的方式执行路线，它返回以下：

{
  "data": {
    "id": 1,
    "name": "demo",
    "username": "demo",
    "avatar_path": "https://via.placeholder.com/640x480.png/0000bb?text=avatar"
  }
}

这是在数据属性中包裹的，我希望该示例具有相同的格式，如何实现这一目标？谢谢。

Answer 1

您可以在userresource.php中写入：

/**
 * @OA\Schema(
 *   @OA\Xml(name="UserResource"),
 *   @OA\Property(property="data", type="array",
 *      @OA\Items(ref="#/components/schemas/User"))
 *   ),
 * )
 */

以及在model user.php中编写

/**
 * @OA\Schema(
 *   @OA\Xml(name="User"),
 *   @OA\Property(format="int64", title="ID", default=1, description="ID", property="id"),
 *   @OA\Property(format="string", title="name", default="Demo", description="Name", property="name"),
 *   @OA\Property(format="string", title="username", default="demo", description="Username", property="username"),
 *   @OA\Property(format="string", title="avatar_path", default="https://via.placeholder.com/640x480.png/0000bb?text=avatar", description="Avatar Path", property="avatar_path")
 * )
 */