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

小说:亚虎老虎机手机版网页作者:董纯建密更新时间:2019-04-19字数:42577

「『长生门』的新掌门,注意??∥乙?ツ阌也嗬玻 乖?词翘锟???话选覆欢?!刮韪龀た沼ハ瑁?酶稣?蠊饷餮艄馄照铡?

www.itb18.com通博

按照这个速度魔人布欧邪恶的部分很快就会被完全同化,想到这里刘皓也没再去关注魔人布欧的生活,反而和布玛一起将精力都投入到了在自己进入超三之后的秘密计划里面。
纪太虚轻轻笑着摇摇头说道:“这种事情也未免太过于血腥了。纵然是在十恶不赦的人,也应当死后为大,全尸还是应该要留的。”

“连我一拳你都接不住还敢叫什么杀拳,不灭金身,简直就是站污这些名字,死吧。”刘皓一拳打碎了绝无神的右臂看着绝无神的惨状没有丝毫的留情留情第二拳直接将绝无神的脑袋给打爆了,绝无神的惨叫也戛然而止。

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

起因:

- A,B. A调用B提供的api接口.

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

测试

1. 测试demo

  • 新建一个spring boot RESTful API项目
    @RequestMapping(value = "/hello", method = RequestMethod.GET)
    public User index() {

        List<String> testList = new ArrayList<String>();
        testList.add("aa");
        testList.add("bb");

        User user=new User();
        user.setName("Grace");
        user.setTestList(testList);

        return user;
    }
  • 浏览器地址栏访问,返回结果没问题,json数据

image

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

image

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

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

image

3. 配置 spring boot RESTful API 支持xml

  • pom

      <dependency>
            <groupId>com.fasterxml.jackson.dataformat</groupId>
            <artifactId>jackson-dataformat-xml</artifactId>
      </dependency>
  • 再次走起

  1. 浏览器

image

  1. curl

image

  1. 注意对比不支持xml的截图 request headers ,内容一样本次为xml类型数据
  2. 服务器根据accept类型(jq ajax 也会推断下面说),从左到右一次匹配,推断返回内容类型 application/xhtml+xml 第二位匹配
  3. 即匹配规则为:最明确的优先匹配。

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

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

  • 走起
  1. 默认情况(不支持xml)
    image
  2. 配置支持xml
    image

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

总结下

  • 浏览器
  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

编辑:平密

发布时间:2019-04-19 06:45:06

当前文章://unoask/question_76652.html

88真人官网 乐虎国际娱乐官网登录 红宝石国际手机app下载 亿宝娱乐客户端下载 w88官方网站手机版 鼎博娱乐app 99发娱乐官网 疯狂7首页官网 

我要说两句: (0人参与)

发布