api接口写好了?想过(Accept,Content-Type)?返回类型json|xml?

起因:

  1. - A,B. A调用B提供的api接口.
  2. - A:为毛你的接口返回的是xml格式的(浏览器访问)?给个json行不行?
  3. - B:没问题啊,我们自己的程序一直在用

测试

1. 测试demo

  • 新建一个spring boot RESTful API项目
  1. @RequestMapping(value = "/hello", method = RequestMethod.GET)
  2. public User index() {
  3. List<String> testList = new ArrayList<String>();
  4. testList.add("aa");
  5. testList.add("bb");
  6. User user=new User();
  7. user.setName("Grace");
  8. user.setTestList(testList);
  9. return user;
  10. }
  • 浏览器地址栏访问,返回结果没问题,json数据

  • 默认是不支持xml的,请求头类型application/xml 无返回数据

2.更直观点看,spirng boot 集成swagger2 并设置 Response Content Type 支持xml,json类型

  • pom
  1. <dependency>
  2. <groupId>io.springfox</groupId>
  3. <artifactId>springfox-swagger2</artifactId>
  4. <version>2.2.2</version>
  5. </dependency>
  6. <dependency>
  7. <groupId>io.springfox</groupId>
  8. <artifactId>springfox-swagger-ui</artifactId>
  9. <version>2.2.2</version>
  10. </dependency>
  • produces
  1. //默认为 */*
  2. //支持xml,json 设置 produces = "application/xml,application/json")
  3. @ApiOperation(value = "user", notes = "note", produces = "application/xml,application/json")
  4. @RequestMapping(value = "/hello", method = RequestMethod.GET)
  5. public User index() {
  • 走起
  1. 注意 Accept,Content-Type , swagger 选择Response Content Type 受影响的是 request headers
  2. 当设置xml类型时 拿不到数据,状态码406
  1. 406 Not Acceptable - [GET]:用户请求的格式不可得(比如用户请求JSON格式,但是只有XML格式)。

3. 配置 spring boot RESTful API 支持xml

  • pom
  1. <dependency>
  2. <groupId>com.fasterxml.jackson.dataformat</groupId>
  3. <artifactId>jackson-dataformat-xml</artifactId>
  4. </dependency>
  • 再次走起
  1. 浏览器



2. curl



2. 注意对比不支持xml的截图 request headers ,内容一样本次为xml类型数据

3. 服务器根据accept类型(jq ajax 也会推断下面说),从左到右一次匹配,推断返回内容类型 application/xhtml+xml 第二位匹配

4. 即匹配规则为:最明确的优先匹配。

  1. Accept:text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8
  1. swagger 走一波

4. 再来看下jQ 下ajax的情况

  • 走起
  1. 默认情况(不支持xml)

  2. 配置支持xml

  3. $.get(xx,xx,xx,dataType) dataType 默认的情况(*/*),按api文档说的jQ会智能推断

总结下

  • 浏览器
  1. 在浏览器地址栏访问的情况下request header Accept:text/html, application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8
  2. 规则,从左到右依次匹配,推断返回内容类型.最明确的优先匹配.本文中xml,json 都支持下,优先选择xml
  • jQ ajax ,
  1. 默认情况下request header accept:*/* jQ会智能推断.如上来看json优先级较高
  2. 通过 dataType 设置 request header accept 类型
  • 开发层面的建议
  1. 涉及到跨组,跨部门,前后端分离的情况借用swagger媒介来沟通api接口情况
  2. 如有xml,json多格式支持的话,设置swagger Response Content Type 来达到多类型支持
  3. 优先使用json格式交互数据

--

  1. 有误的地方欢迎指正,交流

参考链接

  1. 匹配规则 http://blog.csdn.net/blueheart20/article/details/45174399
  2. 406 http://www.ruanyifeng.com/blog/2014/05/restful_api.html
  3. Http报头Accept与Content-Type的区别 http://www.cnblogs.com/-lzb/articles/5035629.html
  4. 推荐优先使用json https://www.cnblogs.com/jaxu/p/7908111.html#a_1
  5. jQ ajax dataType https://api.jquery.com/jquery.ajax/#jQuery-ajax-settings

api接口写好了?想过(Accept,Content-Type)?返回类型json|xml?的更多相关文章

  1. ASP.NET Web API 通过参数控制返回类型(JSON|XML)

    一个很实用的技巧,可以在访问web api服务的时候指定返回数据的格式类型,比如 json 或者 xml. 因为 web api 默认返回的是XML格式,但是现在json 比较流行,同时网上也有其他的 ...

  2. 在Winform混合式框架中整合外部API接口的调用

    在我们常规的业务处理中,一般内部处理的接口多数都是以数据库相关的,基于混合式开发的Winform开发框架,虽然在客户端调用的时候,一般选择也是基于Web API的调用,不过后端我们可能不仅仅是针对我们 ...

  3. 举例说明如何使用【聚合数据】的API接口

    0 注册[聚合数据]的账号 登陆www.juhe.cn,如图,如果没有账号,注册一个(手机号或者邮箱注册),如果有直接登陆即可. 1 搜索所需的API接口 找到聚合数据主页,在搜索框输入你想搜索的AP ...

  4. 利用postman进行api接口开发

    场景: api接口开发时,经常使用一些工具来帮助设计开发.Yapi主要是在设计阶段进行api接口设计,统一前后端参数请求和返回体:swagger主要在开发阶段,用来显示实际上后端开发进度和接口情况:p ...

  5. C# web api 返回类型设置为json的两种方法

    每次写博客,第一句话都是这样的:程序员很苦逼,除了会写程序,还得会写博客!当然,希望将来的一天,某位老板看到此博客,给你的程序员职工加点薪资吧!因为程序员的世界除了苦逼就是沉默.我眼中的程序员大多都不 ...

  6. Web API 2:Action的返回类型

    Web API 2:Action的返回类型 Web API控制器中的Action方法有如下几种返回类型: void HttpResponseMessage IHttpActionResult 其它类型 ...

  7. ASP.NET Web API 2:Action的返回类型

    Web API控制器中的Action方法有如下几种返回类型: void HttpResponseMessage IHttpActionResult 其它类型 基于上面几种不同的返回类型,Web API ...

  8. 如何写出安全的API接口(参数加密+超时处理+私钥验证+Https)- 续(附demo)

    上篇文章说到接口安全的设计思路,如果没有看到上篇博客,建议看完再来看这个. 通过园友们的讨论,以及我自己查了些资料,然后对接口安全做一个相对完善的总结,承诺给大家写个demo,今天一并放出. 对于安全 ...

  9. 第一次写Web API接口

    API是什么?只知道是网络接口,具体怎么写?不会!如何调用?不会!那怎么办? 第一次的经历~~ 需求:为其他项目提供一个接口 功能:为项目提供询盘信息和商家信息,格式为Json字符串 拿过来,就开始做 ...

随机推荐

  1. 为什么MOBA、“吃鸡”游戏不推荐用tcp协议——实测数据

    欢迎大家前往云加社区,获取更多腾讯海量技术实践干货哦~ 作者:腾讯云游戏行业资深架构师 余国良 MOBA类和"吃鸡"游戏为什么对网络延迟要求高? 我们知道,不同类型的游戏因为玩法. ...

  2. 自学Zabbix3.10.1.4-事件通知Notifications upon events-媒介类型Ez Texting

    自学Zabbix3.10.1.4-事件通知Notifications upon events-媒介类型Ez Texting Ez Texting是zabbix的技术合作伙伴,主要提供短信服务,用手机注 ...

  3. Android开发——Toast知识

    Toast.makeText(this, "内容", Toast.LENGTH_SHORT).show(); 直接显示一个Toast,第三个参数是时间的长短,还有一个Toast.L ...

  4. 微信小程序教学第三章第四节(含视频):小程序中级实战教程:下拉更新、分享、阅读标识

    下拉更新.分享.阅读标识 本文配套视频地址: https://v.qq.com/x/page/h0554i4u5ob.html 开始前请把 ch3-4 分支中的 code/ 目录导入微信开发工具 这一 ...

  5. 2. whoami,常用包,调优selinux,七种启动模式,系统开机服务

    1   whoami  查看当前登录用户      useradd zhang   增加用户      passwd  zhang       su - zhang     切换用户        e ...

  6. C#中的GET和SET访问器

    我们在学习C#语法的属性时,都要首先和GET,SET访问器打交道,从英文的字面意思上理解,GET应该就是获得什么什么,而SET应该是设置什么什么,那我们看一下,官方是怎么定义这对访问器的:get是读取 ...

  7. iOS UICollectionView(转三)

    上篇博客的实例是自带的UICollectionViewDelegateFlowLayout布局基础上来做的Demo, 详情请看<iOS开发之窥探UICollectionViewControlle ...

  8. 【NOIP模拟】【USACO】 Bovine Genomics

    Description 给定两个字符串集合A,B,均包含N个字符串,长度均为M,求一个最短的区间[l,r],使得不存在字符串\(a\in A,b\in B,\)且\(a[l,r]=b[l,r]\) , ...

  9. 小白的Python之路 day4 装饰器高潮

    首先装饰器实现的条件: 高阶函数+嵌套函数 =>装饰器 1.首先,我们先定义一个高级函数,去装饰test1函数,得不到我们想要的操作方式 import time #定义高阶函数 def deco ...

  10. c#中treeview的使用方法(转 )

    本文主要介绍treeView控件中,添加,修改.删除节点的操作, 首先当窗体加载的时候,我们添加上图中所示的节点. 当点击“Delete the Selected”按钮时,被选中的节点将被删除. 当点 ...