Spring Boot RestController如何生成Postman调用所需apiKey

核心前提说明 #

你需要调用的接口代码如下：

@GetMapping("/students")
@ApiOperation(value = "", authorizations = {@Authorization(value = "apiKey")})
public Response getAllStudents() {
    return Response
            .ok()
            .setPayload(studentService.getStudents());
}

代码里@ApiOperation注解上的@Authorization(value = "apiKey")是Swagger文档层面的鉴权方案标记，不是指某个固定叫apiKey的加密串，不需要你自己拿用户名密码手动做算法生成，实际鉴权逻辑由项目后端的拦截器/过滤器控制。

第一步：获取有效的apiKey凭证 #

• 用浏览器正常访问系统登录页，按F12打开开发者工具，切换到「网络」面板，勾选「保留日志」选项。
• 输入你已知的用户名密码完成登录，成功跳转到仪表盘后，在网络面板的请求列表里做两个检查：
  • 找到登录接口的响应结果，通常后端会在登录成功的返回体里直接下发鉴权凭证，字段名一般是token、accessToken、apiKey，把这个字段的值复制保存。
  • 随便找一个前端发起的、和/students同权限等级的接口请求，查看它的请求头部分，找到鉴权用的字段名：常见的头名包括apiKey、Authorization、X-API-Key，部分框架会要求凭证值加固定前缀，比如Bearer 你的token值，把这个头名和值的格式记下来，这就是你需要传的apiKey参数。
• 如果项目没有做动态token签发，而是用固定apiKey规则，可以直接在项目代码里找鉴权拦截逻辑（搜索HandlerInterceptor、Filter、apiKey关键字），看校验逻辑要求的参数位置、参数名和值的规则即可。

第二步：Postman端配置 #

• 新建GET请求，填写接口的完整访问地址，比如http://你的项目服务地址/students。
• 切换到请求的「Headers」标签页，新增一行键值对：键填你刚才查到的鉴权请求头名，值填复制好的凭证（注意要求带前缀就完整带上）。
• 如果需要批量调用该项目下的多个接口，可以把接口保存到同一个请求集合，打开集合的「Authorization」配置页，类型选择API Key，依次填写键名、凭证值，参数位置选择「Header」，保存后集合下的所有请求会自动携带该鉴权头，不用重复配置。
• 点击Send发起请求，即可正常获取接口返回数据。

常见问题排查 #

• 不要直接把用户名密码作为apiKey传递：绝大多数场景下apiKey是登录后后端签发的临时凭证，不是明文账号密码。
• 如果请求返回401/403状态码，先检查凭证是否过期，重新登录复制新的token替换旧值即可；再检查请求头的键名、值格式是否和浏览器里正常发起的请求完全一致，不要漏了前缀或者多打空格。
• 如果项目集成了Spring Security、Sa-Token、Shiro等权限框架，鉴权参数的传递规则和框架默认要求一致，对照框架传参规则核对即可。

内容的提问来源于stack exchange，提问作者J. Doe