对于OpenAPI (swagger-php)，如何自动生成查询参数？

Question

我正在编写一个OpenAPI规范，并尝试从请求路由/路径的注释中自动生成可能的查询参数(使用swagger-php)。我知道我可以为每个路由键入所有可能的参数选项，但我真的需要能够使用注释从类的属性自动生成可能的参数，就像我可以对请求正文所做的那样。(我们将有大量的类/路径，除非像请求主体/JsonContent那样生成它们，否则很可能不会保持最新。一般来说，使用swagger-php甚至OpenAPI可以做到这一点吗？

我让它与put和请求主体一起工作，但是对于仍然使用类的属性的get请求，我该如何做呢？

我可以对请求正文执行此操作：

    /**
     * @return Response
     *
     * * @OA\Put(
     *     path="/persons",
     *     tags={"Person"},
     *     @OA\RequestBody(
     *          request="person",
     *          required=false,
     *          description="Optional Request Parameters for Querying",
     *          @OA\JsonContent(ref="#/components/schemas/Person")
     *      ),
     *     @OA\Response(
     *          response="200",
     *          description="Returns matching Person Object",
     *          @OA\JsonContent(
     *              type="array",
     *              @OA\Items(ref="#/components/schemas/Person")
     *          )
     *     )
     * )
     */

为30+类写出每个参数将不可维护：

     /** @OA\Get(
     *     path="/events",
     *     tags={"Events"},
     *     @OA\Parameter(
     *          name="eventID",
     *          in="query",
     *          required=false,
     *          description="The event ID specific to this event",
     *          @OA\Schema(
     *              type="string"
     *          ),
     *     ),
    *
   * ....etc

Answer 1

Swagger-PHP需要注释来记录查询参数。您可以通过添加可以使用$ref="#/components/parameters/PARAM_NAME"引用的顶级@OA\Parameter注释来减少代码重复，如here和here所示。

/**
 * @OA\Parameter(
 *   parameter="eventID_in_query",
 *   name="eventID",
 *   description="The event ID specific to this event",
 *   @OA\Schema(
 *     type="string"
 *   ),
 *   in="query",
 *   required=false
 * )
 */

...

     /** @OA\Get(
     *     path="/events",
     *     tags={"Events"},
     *     @OA\Parameter(ref="#/components/parameters/eventID_in_query"),