如何在PHP中使用Swagger/OpenAPI注解来描述Cookie？

inn6fuwd 于 2023-05-28 发布在 PHP

关注(0)|答案(1)|浏览(208)

bounty明天到期。回答此问题可获得+100声望奖励。Caio Ladislau正在寻找一个答案从一个有信誉的来源。

使用下面的代码块生成swagger文档时：

/**
 * @OA\Get(
 *     path="/api/users",
 *     summary="...",
 *     @OA\Response(
 *         response="200",
 *         description="...",
 *         @OA\Cookie(
 *             name="my_cookie",
 *             description="...",
 *             @OA\Schema(
 *                 type="string"
 *             )
 *         )
 *     )
 * )
 */

我得到一个类似于以下内容的错误消息：

[Syntax Error] Expected Doctrine\Common\Annotations\DocLexer::T_CLOSE_PARENTHESIS, got '@' in...

会有什么问题呢？

swagger

来源：https://stackoverflow.com/questions/76248322/how-to-use-swagger-openapi-annotations-in-php-to-describe-a-cookie

1条答案

按热度按时间

bq3bfh9z1#

根据OpenAPI documentation，当你想描述与响应一起发送的cookie时，你应该通过Set-Cookie头来描述它。
然后你可以用OA Annotations实现它：

/**
     * @OA\Get(
     *     path="/api/users",
     *     summary="...",
     *     @OA\Response(
     *        response="200",
     *        description="...",
     *        @OA\Header(
     *            header="Set-Cookie",
     *            @OA\Schema(
     *                  type="string",
     *                  example="Some value"
     *            )
     *        )
     *    )
     * )
     */

赞(0）回复(0）举报 2023-05-28

我来回答

如何在PHP中使用Swagger/OpenAPI注解来描述Cookie？

1条答案

相关问题

热门标签

最新问答