讲师中心 微信公众号

工具推荐

视频效率加速
剧云
剧云

中文短剧剧本制作平台

AniShort
AniShort

AI短剧协同制作平台

updream

一键生成高质量推广成片

立刻MV
立刻MV

低成本歌曲 MV、视频生成

php怎么实现API文档自动生成_php使用Swagger注解生成文档【文档】

酷敏君_5752

酷敏君_5752

发布时间:2026-02-23 21:42:12

|

469人浏览过

|

来源于php中文网

原创

Swagger注解不生效需确认工具链正确:安装zircote/swagger-php而非仅Swagger UI,注解须置于PHPDoc块内紧贴元素,路径需与实际路由一致,显式声明参数,配置servers字段,扫描时指定准确目录并处理权限与编码问题。

php怎么实现api文档自动生成_php使用swagger注解生成文档【文档】

PHP 项目里 Swagger 注解不生效?先确认是否装对了工具链

Swagger(现叫 OpenAPI)本身不直接解析 PHP 注解,php-swagger 或 zircote/swagger-php 这类库才是实际干活的。常见错误是只装了 Swagger UI,却没在 PHP 侧生成 JSON/YAML 文件——结果浏览器打开 UI 就报 Failed to load spec。

实操建议:

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

  • 用 Composer 安装官方推荐的 zircote/swagger-php:运行 composer require zircote/swagger-php
  • 别用过时的 swagger-php(无命名空间老版本),它不兼容 PHP 8+ 的属性语法
  • 生成命令不是 swagger 命令行(那是 Node.js 版),而是 PHP 脚本调用 OpenApi\scan()
  • 注解必须写在 PHPDoc 块里,且紧贴类、方法或参数上方,中间不能空行

用 @OA\Get 写接口时,路径和参数怎么对应上?

很多人写了 @OA\Get(path="/users"),但路由实际是 /api/v1/users,导致文档路径和真实接口错位。Swagger 不自动读取框架路由配置,所有路径、方法、参数都得手动对齐。

实操建议:

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

  • path 值必须和你最终暴露给前端的 URL 完全一致,包括前缀(如 /api/v1)
  • 查询参数用 @OA\Parameter 显式声明,别指望从函数签名自动提取——function index($id) 不会自动生成 id 参数文档
  • 如果用 Laravel/Slim 等框架,name 字段要和 $request->getQueryParam('page') 里的键名严格一致
  • Body 参数(如 JSON 提交)必须用 @OA\RequestBody + @OA\JsonContent 描述结构,光写 @OA\Property 没用

生成的 openapi.json 里没有服务器地址?

生成的文档默认不带 servers 字段,Swagger UI 就不知道该往哪发请求。测试时点 “Try it out” 直接 404,不是后端问题,是文档缺配置。

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

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

下载

实操建议:

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

  • 在任意一个 PHPDoc 块顶部加 @OA\Info,再嵌套 @OA\Server,例如:
    @OA\Info(
        title="My API",
        version="1.0.0",
        @OA\Server(url="https://api.example.com/v1")
    )
  • 开发环境建议写成变量,比如 @OA\Server(url="http://localhost:8000/api"),上线前批量替换
  • 多个环境(dev/staging/prod)不要硬编码,改用环境变量注入,避免文档生成脚本里混入敏感地址

Laravel 项目里注解被自动过滤?检查 scan() 的路径范围

很多 Laravel 用户把注解放在 app/Http/Controllers,但执行 OpenApi\scan('app') 却扫不出——因为 scan() 默认跳过 vendor 和隐藏文件,但某些 Laravel 配置会让它误判整个 app 目录为“不可读”。

实操建议:

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

  • 显式指定控制器目录:OpenApi\scan(['app/Http/Controllers']),别扫太宽
  • 确保 PHP 进程有权限读取这些文件(尤其是用 Docker 时,宿主机和容器内 UID 不一致会导致扫描静默失败)
  • 注解里别用中文字符串做 description,某些旧版 zircote/swagger-php 会因 UTF-8 编码问题崩溃,先用英文占位
  • 生成脚本里加异常捕获:try { $openapi = OpenApi\scan(...); } catch (\Exception $e) { die($e->getMessage()); },不然失败没提示

最常被忽略的一点:注解语法看似简单,但 @OA\Tag 必须和 @OA\Get 在同一个 PHPDoc 块里才生效;拆成两个 /** */ 块,标签就丢了。

相关文章

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

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

下载

相关标签:

php

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

热门AI工具

更多
小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

WorkBuddy

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

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

豆包大模型

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

码上飞
码上飞 Hot

一款基于自然语言的AI应用开发平台,可根据用户描述自动生成应用程序,帮助个人和团队快速完成应用原型与开发。

二狗PPT
二狗PPT Hot

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

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

DeepSeek

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

Atoms
Atoms Hot

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

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

897

2024.04.09

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

875

2024.04.09

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

2528

2024.04.09

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

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

4881

2024.04.10

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

7150

2025.08.05

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

4696

2025.08.05

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

8789

2025.08.05

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

1516

2026.03.04

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

40

2026.11.06

热门下载

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

精品课程

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

共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