Symfony 7.0 怎么创建API接口?前后端分离

千伟同学_4926

千伟同学_4926

2026-08-07

594人浏览

原创

要在 symfony 7.0 中创建专供前后端分离使用的 api 接口,必须跳过 twig 渲染、禁用 html 响应、统一错误结构,并确保 json 数据可被 vue 或 react 安全消费——任何一步遗漏都会导致前端拿到 html 字符串而非解析后的对象。

symfony 7.0 怎么创建api接口?前后端分离

要在 Symfony 7.0 中创建专供前后端分离使用的 API 接口,必须跳过 Twig 渲染、禁用 HTML 响应、统一错误结构,并确保 JSON 数据可被 Vue 或 React 安全消费——任何一步遗漏都会导致前端拿到 HTML 字符串而非解析后的对象。

禁用 Twig 渲染并强制返回 JSON

打开 config/packages/framework.yaml,确认以下配置已启用:

framework:
  json_request: true
  templating: { engines: [] }
  http_method_override: true

【templating: { engines: [] } 是关键】——它彻底关闭 Twig 引擎,防止控制器意外调用 render() 返回 HTML。若留空或未设,json() 方法在某些路由下仍可能 fallback 到 Twig 渲染。

接着,在控制器中严格使用 json() 方法返回数据,不要混用 render():

return $this->json(['message' => 'OK', 'data' => $user], Response::HTTP_OK);

统一错误响应格式

Symfony 默认 400+ 错误返回 HTML 页面,Vue 的 catch 拿到的是状态码 200 + 一堆 HTML 文本,根本无法解析。必须重写错误控制器。

第一步:创建 src/Controller/ErrorController.php:

class ErrorController extends AbstractController
{
  public function show(Request $request): JsonResponse
  {
    $statusCode = $request->attributes->get('status_code', 500);
    $message = Response::$statusTexts[$statusCode] ?? 'Error';
    return $this->json(['error' => $message, 'status' => $statusCode}, $statusCode);
  }
}

第二步:在 config/packages/framework.yaml 中指定:

framework:
  error_controller: 'App\Controller\ErrorController::show'

这一步不可跳过。否则前端收到 422 错误时,response.json() 会抛出 SyntaxError。

暴露实体为 API 资源(API Platform 方式)

若项目已安装 API Platform(推荐),只需在实体类上加注解即可自动生成 CRUD 接口。

方法一:用 @ApiResource 标记实体

Symfony Linux版
Symfony Linux版

Symfony Linux版整理 Symfony CLI 5.17.1 官方下载入口和 Symfony 框架安装配置说明。

下载

#[ApiResource(mercure: true)]
class Post
{
  #[ORMId]
  #[ORMGeneratedValue]
  #[ORMColumn(type: 'integer')]
  private ?int $id = null;
  #[ORMColumn(type: 'string', length: 255)]
  private string $title;
  // getter/setter...
}

方法二:禁用默认 HTML 输出格式

在 config/packages/api_platform.yaml 中设置:

api_platform:
  formats:
    json: ['application/json']
    # 注释掉或删除 html: ['text/html'] 行

【删除 html 格式支持是硬性要求】——否则 /api/posts 在浏览器直接访问仍返回 HTML,破坏前后端分离契约。

配置跨域与认证 Cookie

开发时前端运行在 http://localhost:5173,Symfony 在 http://localhost:8000,必须让浏览器在跨域请求中携带 Cookie。

第一步:设置响应头

在 config/packages/security.yaml 的 firewall 下添加:

main:
  cors: true
  # 并确保 session 配置含:
session:
  cookie_samesite: 'lax'

第二步:前端 fetch 必须带 credentials: 'include':

fetch('/api/login', { method: 'POST', credentials: 'include', body: JSON.stringify(data) })

第三步:后端响应必须返回 Access-Control-Allow-Credentials: true,且 Access-Control-Allow-Origin 不能为 *——需精确匹配前端域名。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2103

5

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

5630

13

后端的主要工作内容介绍
后端的主要工作内容介绍

后端是应用程序的服务端部分,负责核心任务,如数据库交互、业务逻辑处理和响应客户端请求。想了解更多后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

4926

10

PHP Symfony框架
PHP Symfony框架

本专题专注于PHP主流框架Symfony的学习与应用,系统讲解路由与控制器、依赖注入、ORM数据操作、模板引擎、表单与验证、安全认证及API开发等核心内容。通过企业管理系统、内容管理平台与电商后台等实战案例,帮助学员全面掌握Symfony在企业级应用开发中的实践技能。

2025.09.11

4557

17

PHP API接口开发与RESTful实践
PHP API接口开发与RESTful实践

本专题聚焦 PHP在API接口开发中的应用,系统讲解 RESTful 架构设计原则、路由处理、请求参数解析、JSON数据返回、身份验证(Token/JWT)、跨域处理以及接口调试与异常处理。通过实战案例(如用户管理系统、商品信息接口服务),帮助开发者掌握 PHP构建高效、可维护的RESTful API服务能力。

2025.11.26

504

16

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2023.08.07

1975

5

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.23

2662

1

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

2023.10.13

916

3

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

2025.09.10

2979

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Symfony 官方文档
Symfony 官方文档

共0课时 | 0人学习

Composer手册
Composer手册

共0课时 | 0人学习

Symfony5【从0开始开发博客系统】
Symfony5【从0开始开发博客系统】

共120课时 | 15.1万人学习