NelmioCorsBundle 使用教程
NelmioCorsBundleAdds CORS (Cross-Origin Resource Sharing) headers support in your Symfony application项目地址:https://gitcode.com/gh_mirrors/ne/NelmioCorsBundle
项目介绍
NelmioCorsBundle 是一个 Symfony 包,用于在 Symfony 应用程序中添加跨域资源共享(CORS)头。它允许您以 ACL 风格对每个 URL 进行配置,处理 CORS 预检 OPTIONS 请求,并在响应中添加 CORS 头。
项目快速启动
安装
首先,通过 Composer 安装 NelmioCorsBundle:
composer require nelmio/cors-bundle
如果使用 Symfony Flex,该包会自动启用。否则,需要在 config/bundles.php
中手动启用:
return [
// 其他 bundles
NelmioCorsBundleNelmioCorsBundle::class => ['all' => true],
];
配置
在 config/packages/nelmio_cors.yaml
中添加 CORS 配置:
nelmio_cors:
defaults:
allow_origin: ['*']
allow_methods: ['GET', 'OPTIONS', 'POST', 'PUT', 'PATCH', 'DELETE']
allow_headers: ['Content-Type', 'Authorization']
max_age: 3600
paths:
'^/api/':
allow_origin: ['*']
allow_methods: ['GET', 'OPTIONS', 'POST', 'PUT', 'PATCH', 'DELETE']
allow_headers: ['Content-Type', 'Authorization']
max_age: 3600
hosts: ['^api.']
应用案例和最佳实践
应用案例
假设您有一个 API 端点 /api/users
,您希望允许来自 https://example.com
的跨域请求。您可以在配置中指定:
nelmio_cors:
paths:
'^/api/':
allow_origin: ['https://example.com']
allow_methods: ['GET', 'OPTIONS', 'POST', 'PUT', 'PATCH', 'DELETE']
allow_headers: ['Content-Type', 'Authorization']
max_age: 3600
最佳实践
- 限制允许的来源:不要使用
*
作为allow_origin
,而是明确指定允许的域名。 - 限制请求方法:只允许必要的 HTTP 方法。
- 限制请求头:只允许必要的请求头。
典型生态项目
NelmioCorsBundle 通常与其他 Symfony 包一起使用,例如:
- FOSRestBundle:用于构建 RESTful API。
- JWTAuthenticationBundle:用于处理 JSON Web Token 认证。
- NelmioApiDocBundle:用于生成 API 文档。
这些包与 NelmioCorsBundle 结合使用,可以构建一个完整的、安全的、易于维护的 API 生态系统。
NelmioCorsBundleAdds CORS (Cross-Origin Resource Sharing) headers support in your Symfony application项目地址:https://gitcode.com/gh_mirrors/ne/NelmioCorsBundle