PHPackages                             yangweijie/think-scramble - 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. yangweijie/think-scramble

ActiveLibrary

yangweijie/think-scramble
=========================

ThinkPHP 框架的 OpenAPI 文档自动生成扩展包

v1.4.0(9mo ago)15MITHTMLPHP >=8.0CI failing

Since Jul 27Pushed 9mo agoCompare

[ Source](https://github.com/yangweijie/think-scramble)[ Packagist](https://packagist.org/packages/yangweijie/think-scramble)[ RSS](/packages/yangweijie-think-scramble/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (7)Versions (2)Used By (0)

ThinkScramble
=============

[](#thinkscramble)

[![PHP Version](https://camo.githubusercontent.com/7663c9d53dc13cedaf0660a8745a7e77d2dd711257f36aa86ebce12a0600ef42/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d253345253344382e312d626c75652e737667)](https://php.net/)[![ThinkPHP Version](https://camo.githubusercontent.com/2179f383d87a142476bf4948f52f9e6fccdb5b1ea6055c9078258078a95adaef/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7468696e6b7068702d253345253344382e302d677265656e2e737667)](https://www.thinkphp.cn/)[![License](https://camo.githubusercontent.com/074b89bca64d3edc93a1db6c7e3b1636b874540ba91d66367c0e5e354c56d0ea/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e737667)](LICENSE)[![Tests](https://camo.githubusercontent.com/3ab4882a1b7d64e5eb5168ad0b0b9cdfd53f59f114ee5f727958504214a5789c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74657374732d70617373696e672d627269676874677265656e2e737667)](#testing)[![Export Formats](https://camo.githubusercontent.com/52985d4723c789a81e82c90a9b7eac69489e39ba5e398d6ade6d286105e6beb6/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6578706f7274253230666f726d6174732d31352d6f72616e67652e737667)](#%E5%AF%BC%E5%87%BA%E6%A0%BC%E5%BC%8F%E8%AF%A6%E8%A7%A3)[![UI Renderers](https://camo.githubusercontent.com/44e7b44e9a291c053e45bb225ca2090675820682f5851d0bb10ac883538a0031/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f756925323072656e6465726572732d322d707572706c652e737667)](#%E7%89%B9%E8%89%B2%E5%8A%9F%E8%83%BD)

ThinkScramble 是一个为 ThinkPHP 6/8 框架设计的自动 API 文档生成扩展包，移植自 Laravel Scramble。它能够自动分析你的控制器代码，无需手动编写 PHPDoc 注解，即可生成符合 OpenAPI 3.0 规范的 API 文档。

✨ 特性
----

[](#-特性)

- 🚀 **零配置启动** - 安装即用，无需复杂配置
- 📝 **自动文档生成** - 无需手动编写 PHPDoc 注解
- 🎯 **ThinkPHP 原生支持** - 完全适配 ThinkPHP 8.0 架构
- 📊 **OpenAPI 3.0 标准** - 生成标准的 OpenAPI 文档
- 🎨 **现代化 UI** - 支持 Swagger UI 和 Stoplight Elements 双重界面
- ⚡ **高性能缓存** - 智能缓存机制，支持增量解析
- 🔒 **访问控制** - 灵活的文档访问权限控制
- 📤 **多格式导出** - 支持 15 种导出格式，覆盖主流 API 管理平台
- 🛠️ **命令行工具** - 丰富的 CLI 命令支持
- 🔍 **类型推断** - 智能的 PHP 类型分析引擎

📋 系统要求
------

[](#-系统要求)

- PHP >= 8.1
- ThinkPHP >= 8.0
- Composer

🚀 安装
----

[](#-安装)

### PIE 安装（推荐）

[](#pie-安装推荐)

使用 PIE (PHP Installer for Extensions) 安装，享受现代化的包管理体验：

```
# 安装 PIE（如果尚未安装）
composer global require pie/pie

# 使用 PIE 安装 ThinkScramble
pie install yangweijie/think-scramble

# 验证安装
scramble --version
```

### Composer 安装

[](#composer-安装)

使用 Composer 安装扩展包：

```
composer require yangweijie/think-scramble
```

### PHAR 安装

[](#phar-安装)

下载预构建的 PHAR 文件：

```
# 下载最新版本
curl -L https://github.com/yangweijie/think-scramble/releases/latest/download/scramble.phar -o scramble.phar
chmod +x scramble.phar

# 全局安装
sudo mv scramble.phar /usr/local/bin/scramble

# 验证安装
scramble --version
```

### 自动发现

[](#自动发现)

ThinkPHP 8.0 支持自动服务发现，安装后会自动注册服务。如果需要手动注册，请在 `config/service.php` 中添加：

```
return [
    \Yangweijie\ThinkScramble\Service\ScrambleServiceProvider::class,
];
```

🚀 快速开始
------

[](#-快速开始)

### 1. 创建 API 控制器

[](#1-创建-api-控制器)

```