NelmioCorsBundle 技术文档

1. 安装指南

1.1 使用 Composer 安装

首先，确保你已经安装了 Composer。然后在你的项目根目录下运行以下命令来安装 NelmioCorsBundle：

composer require nelmio/cors-bundle

1.2 手动启用 Bundle

如果你没有使用 Symfony Flex，你需要手动启用 NelmioCorsBundle。在你的 config/bundles.php 文件中添加以下内容：

return [
    // 其他 bundles
    Nelmio\CorsBundle\NelmioCorsBundle::class => ['all' => true],
];

2. 项目的使用说明

NelmioCorsBundle 允许你在 Symfony 应用中发送跨域资源共享（CORS）头信息。你可以通过配置文件来控制哪些 URL 允许跨域请求。

2.1 配置文件

在 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: ['http://example.com']
            allow_methods: ['GET', 'POST']
            allow_headers: ['Content-Type']
            max_age: 600

2.2 处理 OPTIONS 请求

NelmioCorsBundle 会自动处理 CORS 预检请求（OPTIONS 请求），并根据配置添加相应的 CORS 头信息。

3. 项目 API 使用文档

NelmioCorsBundle 本身没有提供 API，但它会在响应中添加 CORS 头信息。你可以通过配置文件来控制这些头信息的值。

3.1 配置 CORS 头信息

你可以在 nelmio_cors.yaml 文件中配置以下 CORS 头信息：

• allow_origin: 允许的来源域名列表。
• allow_methods: 允许的 HTTP 方法列表。
• allow_headers: 允许的请求头列表。
• max_age: 预检请求的缓存时间（以秒为单位）。

4. 项目安装方式

NelmioCorsBundle 的安装方式非常简单，只需通过 Composer 安装即可。安装完成后，你可以根据需要配置 CORS 头信息。

4.1 安装步骤

1. 运行 composer require nelmio/cors-bundle 命令。
2. 如果你没有使用 Symfony Flex，手动启用 Bundle。
3. 在 config/packages/nelmio_cors.yaml 文件中配置 CORS 设置。

通过以上步骤，你就可以在你的 Symfony 项目中使用 NelmioCorsBundle 来处理跨域请求了。