PHP Webman如何对接Swagger文档_Webman自动生成在线API接口手册【提效】

秋静姑娘_4965

秋静姑娘_4965

2026-05-24

1007人浏览

原创

php webman如何对接swagger文档_webman自动生成在线api接口手册【提效】

Webman 里用 Swagger 自动生成 API 文档,不是靠“自动发现路由”,而是靠「手动加注释 + 手动扫描目录 + 静态托管 UI」——它不依赖框架反射机制,所以兼容 PHP 7.4+,也适合 Webman 这类轻量级 Swoole 框架。

为什么 Webman 不能像 Laravel 那样一键生成文档

Webman 没有统一的路由注册中心、没有 Route::apiResource() 这类语义化路由定义,route.php 里通常是闭包或控制器方法直连。Swagger-php 不会解析路由文件,它只认 PHPDoc 注释,且必须能加载到对应类/方法的源码。

  • 你写的是 get('/user', [UserCtrl::class, 'index']),但 Swagger-php 看不到这个映射关系
  • 它只扫描你指定路径下的 PHP 文件,提取其中带 @OA\Get 这类注释的函数或类
  • 所以必须把注释写在控制器方法上方,且该文件得被 PSR-4 或 require 能加载到

必须装对的两个 Composer 包

很多人卡在生成结果为空或报 Class "OpenApiAnnotations" not found,问题就出在这两包没配齐:

  • composer require zircote/swagger-php(v4.x,别装 v3 或 dev 分支)
  • composer require openapi/openapi(v2.0+ 必须显式安装,v4 swagger-php 不再自带 annotation 类)

装完检查 vendor/zircote/swagger-php/src/Annotation.php 是否存在;如果 IDE 写 @OA\Get 不提示补全,八成是漏了 openapi/openapi。

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

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

下载

注释必须紧贴方法,且命名空间不能省

Webman 控制器通常放在 app/controller 下,注释格式必须严格:

  • 用完整命名空间:@OA\Get,不是 @Get 或 @SWGGet(v2 已废弃)
  • 注释块必须紧贴 function 行上方,中间**不能空行**
  • 如果方法是 public function list(Request $request),注释就得写在这一行正上方
  • 确保控制器类本身有 namespace app\controller;,且文件路径与命名空间一致

错误示例:

/** @OA\Get(...) */<br><br>public function list(...)
→ 扫描器跳过,不识别

生成 JSON 并接入 Swagger UI 的实操步骤

别指望 Webman 自带路由导出功能,老老实实用命令行生成 + 静态托管:

  • 新建脚本 swagger.php 在项目根目录:
    <?php <br>require 'vendor/autoload.php';<br>$openapi = \OpenApi\Generator::scan(['app/controller']);<br>file_put_contents('public/docs/openapi.json', $openapi->toJson());
  • 执行 php swagger.php,确认 public/docs/openapi.json 有内容且含 "openapi": "3.0.3"
  • 下载 Swagger UI dist,解压后把 dist/ 全部丢进 public/docs/
  • 修改 public/docs/index.html 中的 url: "./openapi.json"
  • 用 Web 服务器访问(如 php -S localhost:8000 -t public),别双击 HTML 文件——CORS 会拦截本地 JSON

最难的部分不在生成,而在于让 @OA\Response 真实匹配你 return json(...) 的结构。比如返回 ['data' => [...], 'code' => 0],就得手写 @OA\JsonContent 描述 data 字段类型,否则前端看到的是 “unknown schema”。

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

相关文章

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

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

下载

相关标签:

webman php

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

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

9964

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

5921

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2075

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

3708

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4394

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3451

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

4917

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

3842

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

11822

4

热门下载

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

精品课程

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

共0课时 | 306人学习

Webman中文手册
Webman中文手册

共0课时 | 0人学习

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

共15课时 | 2.7万人学习