PHPackages                             hyperf-plus/swagger - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. hyperf-plus/swagger

ActiveLibrary[API Development](/categories/api)

hyperf-plus/swagger
===================

HPlus Swagger 组件 - 自动生成 API 文档，支持 OpenAPI 3.0 规范

v3.1.3(1y ago)44.3k3MITPHPPHP >=8.1CI passing

Since Sep 21Pushed 6mo ago1 watchersCompare

[ Source](https://github.com/hyperf-plus/swagger)[ Packagist](https://packagist.org/packages/hyperf-plus/swagger)[ RSS](/packages/hyperf-plus-swagger/feed)WikiDiscussions master Synced today

READMEChangelog (10)Dependencies (1)Versions (16)Used By (0)

HPlus Swagger 4.0
=================

[](#hplus-swagger-40)

[![PHP Version](https://camo.githubusercontent.com/04744bae0a61d2ffe29c26f07a9612eae20445fc6feaeb77b3af1f0e9be6447c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d253345253344382e312d3838393242462e737667)](https://php.net)[![Hyperf Version](https://camo.githubusercontent.com/7dc19e7a52cb13e2f5eba7d76fd0bfba4d243a9f573d1ea124907388f0af5a21/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6879706572662d253345253344332e312d627269676874677265656e2e737667)](https://hyperf.io)[![OpenAPI](https://camo.githubusercontent.com/35151957cae53ea1f42fdb766c0a75a3b061c5e967406435b9bb63d9684f66e6/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4f70656e4150492d332e312e312d677265656e2e737667)](https://www.openapis.org/)[![License](https://camo.githubusercontent.com/7013272bd27ece47364536a221edb554cd69683b68a46fc0ee96881174c4214c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75652e737667)](LICENSE)

为 Hyperf 框架打造的智能 API 文档生成组件，支持 OpenAPI 3.1.1 规范，自动集成 Route 和 Validate 组件。

✨ 4.0 新特性
---------

[](#-40-新特性)

- 🚀 **OpenAPI 3.1.1** - 完整支持最新规范
- 🔄 **智能集成** - 自动识别 Route 和 Validate 注解
- 📝 **验证规则转换** - 自动将验证规则转为 JSON Schema
- ⚡ **软依赖设计** - validate 插件可选，无则跳过参数解析
- 🎨 **美观 UI** - 集成 Swagger UI，支持在线测试
- 💾 **懒加载+缓存** - 启动零开销，首次访问构建并缓存
- 📋 **FormRequest 支持** - 自动识别 Hyperf FormRequest 验证器

📦 安装
----

[](#-安装)

```
composer require hyperf-plus/swagger:^4.0
```

### 可选依赖

[](#可选依赖)

```
# 路由注解支持
composer require hyperf-plus/route:^4.0

# 验证规则转参数支持
composer require hyperf-plus/validate:^4.0
```

🚀 快速开始
------

[](#-快速开始)

### 1. 发布配置

[](#1-发布配置)

```
php bin/hyperf.php vendor:publish hyperf-plus/swagger
```

### 2. 配置

[](#2-配置)

编辑 `config/autoload/swagger.php`：

```
return [
    'enable' => true,
    'port' => 9501,
    'json_dir' => BASE_PATH . '/runtime/swagger/',
    'html' => '/swagger',
    'url' => '/swagger/openapi.json',
    'auto_generate' => true,
    'scan' => [
        'paths' => [BASE_PATH . '/app'],
    ],
];
```

### 3. 使用示例

[](#3-使用示例)

```