swagger-php注释数组写法

最新推荐文章于 2024-03-18 15:11:00 发布

larance

最新推荐文章于 2024-03-18 15:11:00 发布

阅读量316

点赞数

分类专栏： PHP 文章标签：开发语言 php

本文链接：https://blog.csdn.net/larance001/article/details/129401851

版权

PHP 专栏收录该内容

180 篇文章 0 订阅

订阅专栏

request 请求中包含数组id = [12,123]

    /**
     * @OA\Delete (
     * security={
     *    {"Bearer": {}}
     * },
     *     path="/api/v1/tci/super/user",
     *     tags={"login"},
     *     summary="Delete Super User",
     *     description=".",
     *     operationId="DeleteUser",
     *     @OA\Response(
     *         response="200",
     *         description="Request succeeded",
     *           @OA\JsonContent(
     *             @OA\Property(property="code",title="Response code",type="integer",example=200),
     *             @OA\Property(property="message",title="error message",type="string",example="ok"),
     *             @OA\Property(
     *                      property="data",
     *                      title="Response code",
     *              )
     *       )
     *     ),
     *     @OA\Response(
     *         response="201",
     *         description="request error"
     *     ),
     *  @OA\Parameter(name="id[]", in="query", @OA\Schema(type="array", @OA\Items(type="integer")))
     * )
     */

reponse 中包含数组

    /**
     * @OA\Get(
     * security={
     *    {"Bearer": {}}
     * },
     *     path="/api/v1/tci/super/user",
     *     tags={"login"},
     *     summary="Get Super User",
     *     description=".",
     *     operationId="Get Super User",
     *     @OA\Response(
     *         response="200",
     *         description="Request succeeded",
     *           @OA\JsonContent(
     *             @OA\Property(property="code",title="Response code",type="integer",example=200),
     *             @OA\Property(property="message",title="error message",type="string",example="ok"),
     *             @OA\Property(
     *                      property="data",
     *                      type="array",
     *                     @OA\Items(
     *                  @OA\Property(property="id",title="id",type="integer",example=200),
     *                  @OA\Property(property="userName",title="userName",type="string",example="userName"),
     *                  @OA\Property(property="isApproved",title="isApproved",type="int",example="1"),
     *                  @OA\Property(property="create_people",title="create_people",type="string",example="admin"),
     *                  @OA\Property(property="create_time",title="create_time",type="string",example="2022-11-02 14:12:44"),
     *                  @OA\Property(property="groupId",title="groupId",type="string",example="admin"),
     *                  @OA\Property(property="status",title="status",type="int",example="1"),
     *
     *
     *              )
     *              ),
     *
     *       )
     *     ),
     *     @OA\Response(
     *         response="201",
     *         description="request error"
     *     ),
     *     @OA\RequestBody(
     *     required=true,
     *     request="loginForm",
     *     description="Get super user",
     *       @OA\MediaType(
     *          mediaType="application/x-www-form-urlencoded",
     *           @OA\Schema(
     *             required={"page","size"},
     *             @OA\Property(property="page",title="page",type="int",example="1"),
     *             @OA\Property(property="size",title="size",type="int",example="10"),
     *             @OA\Property(property="search",title="search",type="string",example="name"),
     *          ),
     *       )
     *    )
     * )
     */