讲师中心 微信公众号
AI工具推荐 视频效率加速

ThinkPHP8如何添加授权接口文档

阿静小哥_4363

阿静小哥_4363

发布时间:2026-10-09 13:39:19

|

474人浏览过

|

来源于php中文网

原创

ThinkPHP8授权接口文档需体现认证方式、权限标识、访问限制说明三要素:用OA\SecurityScheme定义认证方案,@Permission注解同步权限码至x-permission字段,中间件校验逻辑对应写入401/403/422状态码说明。

thinkphp8如何添加授权接口文档

ThinkPHP8 添加授权接口文档,核心是把权限控制逻辑和接口描述统一起来,让文档能真实反映“谁能在什么条件下访问哪个接口”。不能只写 Swagger 注释却不校验权限,也不能只写中间件却不在文档中标明认证要求。

授权接口文档必须体现三个关键点:认证方式、权限标识、访问限制说明。

授权方式要在接口文档中明确标注

Swagger-php 5.x 不再默认解析 PHPDoc,改用 PHP 属性注解,所以需在控制器方法上显式声明安全方案:

#[OA\Get(
    path: '/api/v1/user/profile',
    summary: '获取用户个人信息',
    security: [['bearerAuth' => []]], // 表示需要 Bearer Token
)]
#[OA\SecurityScheme(
    securityScheme: 'bearerAuth',
    type: 'http',
    scheme: 'bearer',
    bearerFormat: 'JWT'
)]

注意:security 字段必须与 SecurityScheme 的 securityScheme 名称一致;多个接口共用时,建议在类级或全局定义一次 SecurityScheme,避免重复。

立即学习“PHP免费学习笔记(深入)”;

权限标识要通过自定义注解同步到文档中

ThinkPHP 8 的 @Middleware 注解本身不传递权限码,但你可以用 think-annotation 扩展定义 @Permission 注解,并在生成文档时读取它:

btpanel phpsite 宝塔面板PHP网站
btpanel phpsite 宝塔面板PHP网站

宝塔面板 PHP 网站管理:站点创建、删除、启停、PHP 版本切换、域名管理、SSL证书管理、伪静态管理、数据库管理

下载
#[Permission('user:profile:read')]
public function profile()
{
    return json(['data' => $this->auth->user()]);
}

然后在 Swagger 文档生成脚本中,通过反射提取该注解值,注入到 description 或 x-permission 扩展字段里(Swagger 支持自定义字段):

#[OA\Get(
    description: "需要权限:user:profile:read",
    x: ['permission' => 'user:profile:read'],
)]

这样前端或测试人员一眼就能看到调用该接口所需的最小权限。

访问限制说明要结合中间件行为写进文档

比如你的 JWT 中间件做了以下判断:

  • token 过期自动拒绝
  • role 为 guest 时禁止访问 /user/profile
  • 某些接口还要求 scope=profile_read

这些不能只藏在中间件代码里,得在文档的「认证说明」或「响应状态码」部分体现:

  • 401 Unauthorized:Token 缺失、格式错误或已过期
  • 403 Forbidden:Token 有效但无对应权限(如缺少 user:profile:read)或 scope 不匹配
  • 422 Unprocessable Content:refresh_token 失效且无法静默刷新(适用于带自动续期逻辑的授权流程)

实际写文档时,在接口下方加一段「授权说明」小节即可:

#[OA\Get(
    description: '获取用户个人信息(需登录且具备 user:profile:read 权限)',
)]

这样既保持 Swagger 自动生成能力,又让权限约束可读、可测、可维护。

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

相关专题

更多
thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

3821

2024.04.10

thinkphp性能怎么样
thinkphp性能怎么样

thinkphp 是一款高性能的 php 框架,具备缓存机制、代码优化、并行处理和数据库优化等优势。官方性能测试显示,它每秒可处理超过 10,000 个请求,实际应用中被广泛用于京东商城、携程网等大型网站和企业系统。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1280

2024.04.10

ThinkPHP6后台管理系统开发与RBAC权限控制实践
ThinkPHP6后台管理系统开发与RBAC权限控制实践

本专题围绕 ThinkPHP6 在后台管理系统开发中的应用展开,重点讲解基于 RBAC 模型的权限控制实现方案。内容涵盖管理员角色设计、菜单权限分配、接口鉴权、中间件拦截机制以及后台模块化开发思路。同时结合实际案例,讲解如何构建完整的后台管理系统,包括用户管理、权限管理与操作日志记录,帮助开发者搭建安全、可扩展的企业级后台系统。

503

2026.03.20

ThinkPHP API接口开发与前后端分离实战
ThinkPHP API接口开发与前后端分离实战

本专题围绕ThinkPHP在前后端分离项目中的 API 开发展开,系统讲解 RESTful 接口设计规范、统一返回结构、参数验证与异常处理机制。内容涵盖 Token 鉴权、跨域处理、接口版本管理以及接口文档生成方案。通过完整项目案例,帮助开发者构建规范、高效、易维护的后端接口服务体系。

344

2026.03.20

ThinkPHP ORM模型关系与数据库操作优化实践
ThinkPHP ORM模型关系与数据库操作优化实践

本专题聚焦ThinkPHP中 ORM 模型的高级用法与数据库操作优化技巧。内容包括一对一、一对多、多对多关系定义与使用、关联预加载、查询构建器优化以及复杂查询封装方法。同时结合实际业务场景,讲解如何避免 N+1 查询问题、提升数据库访问效率,帮助开发者编写高性能的数据访问层代码。

239

2026.03.20

ThinkPHP模型详解
ThinkPHP模型详解

本专题整合了ThinkPHP模型相关内容,阅读专题下面的文章了解更多详细介绍。

278

2026.03.26

ThinkPHP表单验证与数据安全处理实战
ThinkPHP表单验证与数据安全处理实战

本专题聚焦 ThinkPHP 在表单处理中的验证与安全机制,系统讲解验证器使用、自定义规则、场景验证以及错误提示处理。内容涵盖 XSS 防护、SQL 注入防御、数据过滤与输入校验等关键安全措施。通过实际案例,帮助开发者构建安全可靠的数据处理流程。

221

2026.03.30

ThinkPHP日志系统设计与异常监控实践
ThinkPHP日志系统设计与异常监控实践

本专题围绕 ThinkPHP 日志系统展开,深入讲解日志记录机制、日志级别划分、日志文件管理以及自定义日志通道配置。内容涵盖异常捕获、错误追踪、调试信息输出以及日志分析方法。通过实战讲解,帮助开发者提升系统问题定位能力与运维效率。

428

2026.03.30

FrankenPHP集成Laravel详细教程
FrankenPHP集成Laravel详细教程

本专题提供FrankenPHP集成Laravel的详细配置指南,全面解析运行原理、开发环境搭建、Caddyfile配置、Octane工作模式、数据库连接、队列任务、定时任务和生产环境优化,解决部署过程中常见的报错与兼容性问题。

40

2026.10.08

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn