PhpStorm辅助编写OpenAPI文档的插件

小磊姑娘_1322

小磊姑娘_1322

2026-09-13

730人浏览

原创

必须同时安装swagger plugin和php annotations插件并重启ide,项目需含zircote/swagger-php依赖,且yaml/json文件须被识别为openapi specification类型,三者缺一不可,否则注解不高亮、无参数补全、预览不出现。

phpstorm辅助编写openapi文档的插件

Swagger Plugin 和 PHP Annotations 插件必须同时安装

只装 Swagger Plugin 不会识别 @OA\Get,只装 PHP Annotations 也不会高亮注解或补全参数——两者缺一不可。安装后必须重启 IDE,否则已打开的 PHP 文件里注解仍不生效。

Settings → Plugins(macOS 是 PhpStorm → Preferences → Plugins)中搜索并安装:

  • Swagger Plugin(官方名:SwaggerHub API Design by SmartBear)
  • PHP Annotations

项目必须有 zircote/swagger-php 且被正确加载

插件只是“翻译器”,没有 zircote/swagger-php@OA\ 命名空间会标红,补全菜单为空。运行以下命令安装:

composer require --dev zircote/swagger-php

还要确保 PHP 文件中引用了命名空间:

PHP
PHP

编写健壮的PHP代码,规避类型转换陷阱、数组怪癖及常见安全漏洞。

下载
  • 要么顶部写 use OpenApi\Annotations as OA;,然后用 @OA\Get
  • 要么直接用完全限定名 @OA\Get(前提是 autoloader 已加载该类)
  • 如果用了自定义别名如 use OpenApi\Annotations as SWG;,插件默认不识别 @SWG\Get,得手动配置注解前缀

YAML/JSON 文件必须被识别为 OpenAPI Specification 类型

否则没有语法校验、$ref 跳转、路径补全,也打不开预览。判断依据:光标放在 paths: 下按 Alt+Insert 应出现 gutter 小加号。

若已有 openapi.yaml 但没识别:

  • 右键文件 → Override File Type → OpenAPI Specification
  • 或新建时用 File → New → OpenAPI Specification,选 OpenAPI 3.0 (YAML)
  • 空文件可输入 opnp + Tab 插入模板

Preview 标签页不出现?检查 OpenAPI 预览是否启用

预览功能默认关闭,且只支持本地 YAML/JSON 文件,不代理后端接口。打开 Settings → Languages & Frameworks → OpenAPI Specifications,确认勾选了 Enable preview

打开已识别为 OpenAPI 的文件后,编辑器右上角应出现 Preview 标签页。注意:

  • 此预览纯静态渲染,不发真实请求
  • 不支持 server.url 动态变量,所有路径都按文档字面量解析
  • 若内容为空白或报错,先检查 YAML 缩进和冒号后空格——这类格式错误不会高亮,但会导致预览失败
真正让注解“活起来”的三个条件:两个插件、一个依赖、一种文件类型识别——少一个,@OA\ 就只是普通字符串。最常被忽略的是重启 IDE 和手动设置文件类型。

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

相关文章

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

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

下载

相关标签:

phpstorm插件 php phpstorm

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

相关专题

更多
phpstorm怎么导出项目
phpstorm怎么导出项目

phpstorm提供导出项目功能,步骤如下:打开phpstorm项目转到“项目”菜单选择“导出项目”选择导出格式指定导出位置选择导出范围勾选“包括依赖项”框(可选)单击“导出”完成导出。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.08

1168

7

phpStorm怎么运行
phpStorm怎么运行

本专题整合了phpstorm运行教程,阅读专题下面的文章了解更多相关内容。

2025.09.18

4378

13

phpstorm开发环境搭建教程
phpstorm开发环境搭建教程

本专题整合了phpstorm开发环境搭建和运行项目教程,阅读专题下面的文章了解更多详细教程。

2025.09.18

4776

18

phpstorm怎样运行php
phpstorm怎样运行php

本专题整合了phpstorm运行php相关教程,阅读专题下面的文章了解更多详细内容。

2025.09.18

1821

11

phpstorm相关教程大全
phpstorm相关教程大全

本专题整合了phpstorm相关教程汇总,阅读专题下面的文章了解更多详细内容。

2026.01.15

98

24

从环境搭建到代码调试:PHPstorm全流程开发配置指南
从环境搭建到代码调试:PHPstorm全流程开发配置指南

本文旨在为PHP开发者提供一份详尽的PhpStorm全流程开发配置指南。内容涵盖从IDE安装、PHP解释器配置、Xdebug调试环境搭建,到项目运行与断点调试的完整流程。通过本指南,读者将掌握搭建高效开发环境的核心技能,快速上手PhpStorm的强大功能,显著提升PHP开发效率。

2026.04.01

61

11

PHPstorm编辑器全系统安装与激活配置指南
PHPstorm编辑器全系统安装与激活配置指南

本文提供一份详尽的PHPstorm全系统安装与激活配置指南,覆盖Windows、macOS及Linux三大主流平台。内容从官方安装包的获取、安装过程中的路径与组件选择,到激活流程(包括正版激活与补丁替换法)均有详细图解。此外,指南还包含安装后的基础环境配置与中文语言包安装,旨在帮助开发者快速完成IDE部署,为PHP开发搭建一个稳定、高效的集成环境。

2026.04.01

196

9

ps软件新手入门教程合集
ps软件新手入门教程合集

PHP中文网精心打造了本PS新手入门教程合集。内容涵盖软件安装、界面认知、图层管理及抠图调色等核心技能,提供从零基础到精通的系统化学习路径。无论您是想快速上手修图还是进阶平面设计,都能在此找到实用指南与实战案例,助您轻松玩转Photoshop。

2026.06.11

700

17

热门下载

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

精品课程

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

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

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

共0课时 | 0人学习