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

Question

我正在编写一个OpenAPI规范，并试图从请求路由/路径的注释中自动（使用swagger-php）生成我可能的查询参数。我知道我可以为每个路由键入所有可能的参数选项，但我确实需要能够使用注释从类的属性自动生成可能的参数，就像我可以为请求体所做的那样。（我们将有大量的类/路径，除非它们像请求体/JSONContent那样生成，否则很可能无法保持更新。这在一般的swagger-php甚至OpenAPI中可能吗？

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

php prettyprint-override">    /**
     * @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需要注释来记录查询参数。通过添加顶级@oa\parameter注释，可以在一定程度上减少代码重复，这些注释可以使用$ref=“#/components/parameters/param_name”引用，如下所示。

/**
 * @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"),