rest - 如何在 NelmioApiDoc Bundle 中添加 RequestBody 示例？

Question

我的注释是：

     * @OA\RequestBody(
     *     required=true,
     *     @OA\JsonContent(
     *         @OA\Schema (
     *              type="object",
     *              @OA\Property(property="status", required=true, description="EventStatus", type="string"),
     *              @OA\Property(property="comment", required=false, description="Change Status Comment", type="string"),
     *              example={
     *                  "status": "test status",
     *                  "comment": "test comment"
     *              }
     *         )
     *     )
     * )

我试图添加一个“示例”键，但它不起作用。

标签： restsymfonynelmioapidocbundle

Answer 1

examplekey 必须是@OA\JsonContent下面的一部分。

 * @OA\RequestBody(
 *     required=true,
 *     @OA\JsonContent(
 *         example={
 *             "status": "status",
 *             "comment": "comment"
 *         },
 *         @OA\Schema (
 *              type="object",
 *              @OA\Property(property="status", required=true, description="Event Status", type="string"),
 *              @OA\Property(property="comment", required=false, description="Change Status Comment", type="string"),
 *         )
 *     )
 * )