PHPackages                             tangwei/apidocs - 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. tangwei/apidocs

ActiveLibrary[API Development](/categories/api)

tangwei/apidocs
===============

A swagger library for Hyperf.

v3.1.4(8mo ago)51130.4k↓12%17[2 issues](https://github.com/tw2066/api-docs/issues)7MITPHPPHP >=8.1CI passing

Since Oct 14Pushed 1mo ago2 watchersCompare

[ Source](https://github.com/tw2066/api-docs)[ Packagist](https://packagist.org/packages/tangwei/apidocs)[ RSS](/packages/tangwei-apidocs/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (7)Versions (52)Used By (7)

PHP Hyperf API Docs
===================

[](#php-hyperf-api-docs)

[![Latest Stable Version](https://camo.githubusercontent.com/aa987cdf7ab3c6b3b6a58082e2b5208846ccc65027661b1c89b033741da4696d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f74616e677765692f617069646f6373)](https://packagist.org/packages/tangwei/apidocs)[![Total Downloads](https://camo.githubusercontent.com/b5c9369d5c6474d8cd1ca5b29882b16b6b1ff76f98a1422d81f2b51d6e9488c6/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f74616e677765692f617069646f6373)](https://packagist.org/packages/tangwei/apidocs)[![License](https://camo.githubusercontent.com/5bbb99b825295b19c14b0286414ecfbacad1e810ea2204b35966e54444351776/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f74616e677765692f617069646f6373)](https://github.com/tw2066/api-docs)[![PHP Version](https://camo.githubusercontent.com/6518db1335bf20fdff07253dc6d6d0cec955b5fb6a8ef1382ac6d73687ecc07f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d253345253344382e312d626c7565)](https://www.php.net)

[English](./README_EN.md) | 中文

基于 [Hyperf](https://github.com/hyperf/hyperf) 框架的 Swagger/OpenAPI 文档自动生成组件，支持 Swoole/Swow 引擎，为您提供优雅的 API 文档解决方案。

✨ 特性
----

[](#-特性)

- 🚀 **自动生成** - 基于 PHP 8 Attributes 自动生成 OpenAPI 3.0/3.1 文档
- 🎯 **类型安全** - 支持 DTO 模式，参数自动映射到 PHP 类
- 📝 **多种 UI** - 支持 Swagger UI、Knife4j、Redoc、RapiDoc、Scalar 等多种文档界面
- ✅ **数据验证** - 集成 Hyperf 验证器，支持丰富的验证注解
- 🔒 **安全认证** - 支持 API Token 和多种安全方案
- 🔄 **类型支持** - 支持数组、递归、嵌套、枚举等复杂类型
- 🎨 **灵活配置** - 可自定义全局响应格式、路由前缀等
- 📦 **开箱即用** - 零配置即可使用，同时支持深度定制

📋 环境要求
------

[](#-环境要求)

- PHP >= 8.1
- Hyperf >= 3.0
- Swoole >= 5.0 或 Swow

💡 使用须知
------

[](#-使用须知)

- 控制器方法尽可能返回具体的类（包含简单类型），这样能更好地生成文档
- 当返回类无法满足需求时，可使用 `#[ApiResponse]` 注解补充

📦 安装
----

[](#-安装)

```
composer require tangwei/apidocs
```

默认使用 Swagger UI，推荐安装 Knife4j UI（可选）：

```
composer require tangwei/knife4j-ui
```

🚀 快速开始
------

[](#-快速开始)

### 1. 发布配置文件

[](#1-发布配置文件)

```
php bin/hyperf.php vendor:publish tangwei/apidocs
```

配置文件将发布到 `config/autoload/api_docs.php`

### 2. 基础配置

[](#2-基础配置)

```