REST API返回XML还是JSON更好

9次阅读

jsON更合适,因其解析成本低、浏览器原生支持、移动端SDK默认支持、Content-Type更轻量、字段名无需转义、体积小20%–40%;xml仅在需XSD校验、XSLT渲染或SOAP集成时不可替代。

REST API返回XML还是JSON更好

json 更合适,除非你明确需要 XML 的特定能力(比如 XSLT 渲染、严格 Schema 验证、遗留系统集成)。

现代 rest api 默认用 JSON 是因为客户端解析成本低

浏览器原生支持 JSON.parse()JSON.stringify();移动端 SDK(如 retrofit、Alamofire)默认反序列化 JSON。XML 需要额外依赖(如 DOMParserxml2jslxml),且容易因格式缩进、命名空间、CDATA 处理出错。

  • http Content-Typeapplication/jsonapplication/xmltext/xml 更轻量,无编码歧义
  • JSON 字段名不用转义,XML 的 & 必须实体化,增加序列化/反序列化负担
  • 同结构数据,JSON 体积通常比 XML 小 20%–40%,对移动网络和带宽敏感场景更友好

XML 唯一不可替代的场景是需要 Schema 约束或文档级语义

如果你的 API 要被政府/金融等强合规系统调用,且对方要求 XSD 校验、XSLT 直接渲染 html,或必须兼容老式 SOAP 客户端,那 XML 是合理选择。但注意:这已不是“restful”风格,而是混合架构

  • 不要仅因“XML 看起来更正式”就选它——REST 不关心格式,只关心统一接口语义
  • 如果只是想做字段校验,用 JSON Schema + application/schema+json 更现代
  • Accept 头支持多格式(如 Accept: application/json, application/xml;q=0.9)可以兼顾,但服务器端实现成本翻倍,且多数客户端不发 Accept

别在同一个 API 里动态切换 JSON/XML 基于 URL 后缀

/users.json/users.xml 这种设计违反 REST 的内容协商原则,也增加路由维护复杂度。正确做法是靠 Accept 请求头驱动,后端标准库处理(如 expressres.format()spring Boot 的 @ResponseBody + MappingJackson2HttpMessageConverter / Jaxb2RootElementHttpMessageConverter)。

  • spring boot 默认禁用 XML 支持,需显式添加 spring-boot-starter-web + javax.xml.bind:jaxb-api(Java 11+ 还得加 org.glassfish.jaxb:jaxb-runtime
  • python flask 默认无 XML 支持,要用 flask-xmlrpc 或手写 Response + xml.etree.ElementTree,易出 UnicodeEncodeError
  • 错误响应也要保持格式一致:返回 400 Bad Request 时,JSON 错误体是 {"error": "invalid_id"},XML 就该是 invalid_id,不能混用
const express = require('express'); const app = express();  app.get('/api/users', (req, res) => {   const users = [{ id: 1, name: 'Alice' }];      res.format({     'application/json': () => res.json(users),     'application/xml': () => {       const xml = `${users.map(u => `${u.id}${u.name}`).join('')} `;       res.set('Content-Type', 'application/xml').send(xml);     },     default: () => res.status(406).send('Not Acceptable')   }); });

真正难的不是选 JSON 还是 XML,而是保持错误码、分页字段、时间格式(ISO 8601)、空值表示(NULL vs )在所有格式中完全一致——这点常被忽略,却直接影响客户端健壮性。

text=ZqhQzanResources