下面如何用注释编写这个JSON swagger-php呢？

Question

我正在使用OpenAPI 3.0来记录我的Symfony。这是验证用户发送请求的JSON代码：

"securitySchemes": {
        "Bearer": {
            "type": "http",
            "description": "Entrer le token JST",
            "scheme": "bearer",
            "bearerFormat": "JWT"
        }
    }
},
"security": [
    {
        "Bearer": []
    }
]

我如何用控制器中的注释来写这个呢？

谢谢

Answer 1

您几乎可以；目前swagger-php不支持bearerFormat属性。

=> https://github.com/zircote/swagger-php/issues/1258

其余的在全球范围内都是这样。

/**
 *     @OA\SecurityScheme(
 *         securityScheme="bearerAuth",
 *         type="http",
 *         scheme="bearer",
 *         description="Entrer le token JST"
 *     )
 */

要使控制器需要安全性，可以添加以下内容：

/**
 * @OA\Get(
 *     path="/api/endpoint",
 *     ...
 *     security={{ "bearerAuth": {} }}
 * )
 */