安全性

编辑此页

默认安全策略可以在 nelmio_api_doc.documentation.security 中添加

        1
2
3
4
5
6
7
8
9
10
11
12
13
        nelmio_api_doc:
    documentation:
        components:
            securitySchemes:
                Bearer:
                    type: http
                    scheme: bearer
                ApiKeyAuth:
                    type: apiKey
                    in: header
                    name: X-API-Key
        security:
            - Bearer: []
    

这会将 Bearer 安全策略添加到所有注册路径。

覆盖特定路径

可以使用 Security 属性/注解来覆盖路径的安全策略。

        1
2
3
        /**
 * @Security(name="ApiKeyAuth")
 */
    

请注意，在文档块底部有一个名为 `ApiKeyAuth` 的 Security 属性/注解。这将覆盖全局安全策略，仅接受此路径的 ApiKeyAuth 策略。

您还可以通过提供名为 null 的 Security 来完全删除路径的安全性。

        1
2
3
        /**
 * @Security(name=null)
 */
    

本作品，包括代码示例，均根据 Creative Commons BY-SA 3.0 许可协议获得许可。

版本