Webman集成Swagger自动生成API文档

千浩酱_2000

千浩酱_2000

2026-06-23

332人浏览

原创

webman集成swagger必须注释+扫描+托管三步闭环,否则openapi.json为空或404;因swagger-php仅扫描php源码中紧贴方法的@oa\注释,不解析route.php,且依赖psr-4自动加载。

webman集成swagger自动生成api文档

Webman 集成 Swagger 不能靠“自动发现路由”,必须靠「注释 + 扫描 + 托管」三步闭环——漏掉任意一环,openapi.json 就是空文件或 404。

为什么 @OA\Get 注释写了却没生成接口?

Swagger-php 不解析 route.php,只扫描 PHP 源码中带 @OA\ 前缀的注释块。常见失效原因:

  • 注释没紧贴方法:/** @OA\Get() */ 和 public function index() 中间有空行 → 被跳过
  • 用了旧命名空间:@SWG\Get 或 @Get → v4 不识别,必须用 @OA\Get
  • 控制器没声明命名空间,或路径与 namespace 不一致(如文件在 app/controller/User.php,但写的是 namespace app\ctrl;)
  • vendor/openapi/openapi 没装:仅装 zircote/swagger-php 会报 Class "OpenApiAnnotations" not found

用 webman-tech/swagger 零配置启动的实操要点

这是目前 Webman 下最省事的方案,但默认行为容易踩坑:

Webman 2.2.0
Webman 2.2.0

Webman 2.2.0版本强化了 TCP/UDP 服务支持,优化路由组管理,并增强异步任务处理能力。结合协程与连接池技术,Webman 能轻松应对高并发场景,适用于网站、接口服务、即时通讯、物联网及游戏开发,兼具高性能、灵活扩展与稳定可靠,是多场景 PHP 服务开发的理想选择。

下载
  • 安装后访问 /openapi 404?检查是否启用了 global_route:它默认扫描 app_path(),但若你把控制器放在 app/api/ 下,需手动指定目录
  • 文档里看不到请求体示例?确保在方法参数上加了 #[OA\RequestBody] 或 @OA\RequestBody,且引用了正确的 Schema 类
  • 修改 title 或 version 失效?别只改 @OA\Info 注释——v5.1+ 推荐用配置项 modify 回调,它能动态覆盖生成结果
  • 开发时改了注释但 UI 没更新?确认 app.php 中 'openapi_doc' => ['cache' => true] 在 dev 环境下设为 false,否则读缓存

手动生成 openapi.json 并托管到 /docs 的关键步骤

适合需要对接 YAPI、做 CI/CD 或禁用动态路由的场景,注意路径和权限:

  • 脚本 swagger.php 必须用 __DIR__.'/app/controller',不能写相对路径如 ../app/controller(Swoole 下工作路径不稳定)
  • file_put_contents('public/docs/openapi.json', ...) 前确认 public/docs 目录存在且 Web 进程有写权限
  • Swagger UI 的 index.html 里 url: "./openapi.json" 必须和实际 HTTP 路径一致;如果托管在 /api-docs,就得改成 url: "/api-docs/openapi.json"
  • Nginx/Apache 需显式允许静态 JSON 访问:某些配置会拦截 .json 后缀走 PHP-FPM,导致下载而不是渲染

最常被忽略的是注释与类加载的关系:Swagger-php 只处理能被 require 或 PSR-4 自动加载的文件。如果你用 include 'xxx.php' 动态引入控制器,那些文件里的 @OA\ 注释永远不会被扫描到。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

相关标签:

webman

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

相关专题

更多
Webman入门教程合集
Webman入门教程合集

本专题聚焦Webman高性能PHP框架,为您提供零基础入门的一站式全攻略。内容涵盖开发环境搭建全流程、核心原理解析(如目录结构、生命周期)及API接口实战开发。无论您是初次接触还是进阶巩固,都能在此找到实用的教程合集,助您快速掌握这款“常驻内存”的PHP利器,实现高性能后端应用的高效构建。

2026.05.21

237

12

Webman框架集成与数据库配置
Webman框架集成与数据库配置

本专题聚焦 Webman 高性能 PHP 框架,为您提供一站式后端开发全攻略。内容深度涵盖框架快速入门、多数据库进阶配置(Eloquent & ThinkORM)、以及企业级核心组件集成(如 JWT 鉴权、RabbitMQ 消息队列、Elasticsearch 全文搜索)。

2026.05.21

167

16

Webman常见问题与错误排查
Webman常见问题与错误排查

本专区深度聚焦 Webman 高性能框架常见故障与性能调优,为您提供一站式全能排查攻略。内容精准覆盖 404/500 核心报错修复、内存溢出(Memory Limit)深度排查、以及 Redis 连接与 Session 失效等开发者高频痛点。

2026.05.21

309

15

Webman框架功能开发全指南
Webman框架功能开发全指南

本专题深度聚焦 Webman 高性能 PHP 框架全功能模块开发,为您提供一站式实战全攻略。内容深度涵盖从基础的 RESTful API 规范化设计到高阶的即时通讯(WebSocket)、多语言国际化(i18n)及定时任务系统等等。

2026.05.21

324

32

Webman部署与运维指南
Webman部署与运维指南

本专区聚焦 Webman 高性能框架生产级部署与运维实战,为您提供一站式全攻略。内容深度涵盖 Linux/Windows 多端环境搭建、核心架构方案(如 Docker 容器化扩容、负载均衡下的 Session 共享、集群一致性部署)及自动化运维体系。

2026.05.21

318

14

Webman协程与高性能优化
Webman协程与高性能优化

本专区聚焦 Webman 协程与高性能优化教程,为您提供一站式学习攻略。内容涵盖框架协程机制详解、性能优化策略、实战示例及常见问题解析。无论您是 PHP 开发初学者,还是追求高并发优化的进阶开发者,都能在此找到实用指南,助您全面掌握 Webman 高性能 PHP 框架,实现高效、可扩展的 Web 应用开发。

2026.05.21

277

15

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

2026.09.23

60

15

Buffalo框架路由与请求处理实操指南
Buffalo框架路由与请求处理实操指南

本专题讲解Buffalo框架路由与请求处理机制,涵盖路由注册与分组、资源路由、Handler编写规范、Context上下文方法、参数绑定、中间件编写挂载、Session与Cookie读写、Flash消息及错误页面定制方法。

2026.09.23

20

15

Buffalo框架零基础入门教程
Buffalo框架零基础入门教程

本专题整理Buffalo框架入门内容,涵盖Go环境准备、buffalo CLI安装、新项目生成、目录结构说明、dev热加载启动、数据库连接配置与常见报错排查,帮助新手按约定优于配置的思路跑通第一个Buffalo框架应用。

2026.09.23

20

15

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Webman和FastAPI的性能对比
Webman和FastAPI的性能对比

共0课时 | 288人学习

Webman中文手册
Webman中文手册

共0课时 | 0人学习

webman初步使用及后台搭建
webman初步使用及后台搭建

共15课时 | 2.6万人学习