Swagger:在哪里设置授权的API-Key

Question

我使用的是Nelmio APi Doc 3.4。大摇大摆。我想对我的api使用apiKey授权。我在nelmio_api_doc.yaml中设置了配置

nelmio_api_doc:
    documentation:
            schemes: [https]
            securityDefinitions:
                app_api_key:
                    type: apiKey
                    description: 'App Api Key'
                    name: Authorization
                    in: header
            security:
                - app_api_key: []

在我的控制器中，我在注释中设置了参数：

....
@SWG\Parameter(
     *         name="Authorization",
     *         in="header",
     *         required=true,
     *         type="string",
     *         default="PUT HERE THE KEY",
     *         description="Authorization"
     *     )
*/
public function getProductAction()
{
....
}

但是我应该在哪里设置我的ApiKey呢？例如，我有一个apiKey "abc123“，我想用insert键来检查它。我不明白这个函数在哪里。有人能帮我一下吗？

Answer 1

我认为您应该使用安全授权的特定注释：

use Nelmio\ApiDocBundle\Annotation as Nelmio;

/**
 * @Nelmio\Security(name="app_api_key"),
 * @SWG\Get()
 */
public function getProductAction()
{
    //...
}