使用swagger传递map类型的参数报错406

Posted

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了使用swagger传递map类型的参数报错406相关的知识,希望对你有一定的参考价值。

1、前言

最近在实现一个分页查询所有的用户及其角色的功能时,遇到了406的问题,费了好长时间才解决,记录一下解决方法。

2、排错过程

前后端分离的项目,写接口的时候我用到了swagger框架。先说下406是什么意思?

406:请求的资源的内容特性无法满足请求头中的条件,因而无法生成响应实体。实体格式由Content-Type头定义的媒体类型决定

解释一下:返回的消息头浏览器无法解释,下面是两种不同的消息头:

技术分享图片

技术分享图片

3、解决方法

  • 导入下面三个jar包
    ?
    <!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-databind -->
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.9.5</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-core -->
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-core</artifactId>
            <version>2.9.7</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-annotations -->
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-annotations</artifactId>
            <version>2.9.7</version>
        </dependency>
  • 使用@ResponseBody注解
/**
     * 查询所有用户
     * 
     * @param pn
     * @return
     */
    @SuppressWarnings("unchecked")
    @RequestMapping(value = "/userRoleList", method = RequestMethod.GET)
    @RequiresRoles(value = "超级管理员")
    @ResponseBody
    @ApiOperation(value = "查询所有用户", notes = "查询所有用户", httpMethod = "GET")
    public Msg UserRoleList(@RequestParam(value = "pn", defaultValue = "1") String pn,
            @RequestParam(value = "ps", defaultValue = "5") String ps) {
        // 1. 分页查询所有的用户
        PageHelper.startPage(Integer.parseInt(pn), Integer.parseInt(ps)); // 传入页码,每页大小
        List<Admin> admins = adminService.findAll();
        // 2. 根据用户名查询每个用户各自的角色
        List<Map<String, Object>> list = new ArrayList<Map<String, Object>>();
        for (Admin admin : admins) {
            List<Role> roles = adminService.findRoles(admin.getAdminName());
            //添加用户
            LinkedHashMap<String, Object> admin_roles = new LinkedHashMap<String,Object>();
            admin_roles.put("id", admin.getId());
            admin_roles.put("adminName", admin.getAdminName());
            admin_roles.put("name", admin.getName());
            admin_roles.put("createTime", admin.getCreateTime());
            admin_roles.put("lastLoginTime", admin.getLastLoginTime());
            admin_roles.put("locked", admin.getLocked()>0?true:false);
            //添加角色
            List<String> roleName = new ArrayList<String>();
            for (Role role : roles) {
                roleName.add(role.getName());
            }
            admin_roles.put("roles", roleName);
            //将用户及其角色存放的list中
            list.add(admin_roles);
        }
        // 3. 分页信息
        PageInfo page = new PageInfo(admins);
        return Msg.success().add("list", list).add("total", page.getTotal());
    }
  • 更改swagger版本为2.8
    <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.8.0</version>
        </dependency>

以上是关于使用swagger传递map类型的参数报错406的主要内容,如果未能解决你的问题,请参考以下文章

mybatis报错:A query was run and no Result Maps were found for the Mapped StatementProperty [login_ip(代

怎样将从Action中拿出来的map作为参数传给一个参数为map的js函数呢?

Swagger/OpenAPI - 使用 $ref 传递可重用的定义参数

MyBatis的DAO接口中参数传递建议使用map类型的原因

swagger2的常用注解,传递参数的注意使用方法

HTTP 406 错误服务器响应:在请求中发送过滤参数时