PHPackages siushin/laravel-api - 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. siushin/laravel-api ActiveProject[API Development](/categories/api) siushin/laravel-api =================== GPAdmin-api 基于 Laravel 的API框架，提供常用工具类、助手函数等服务 02PHPCI passing Since Jan 28Pushed 3mo agoCompare [ Source](https://github.com/siushin/GPAdmin-api)[ Packagist](https://packagist.org/packages/siushin/laravel-api)[ RSS](/packages/siushin-laravel-api/feed)WikiDiscussions main Synced 1mo ago READMEChangelogDependenciesVersions (1)Used By (0) GPAdmin-api =========== [](#gpadmin-api) 基于 Laravel 的 API 框架，提供常用工具类、助手函数等服务，采用模块化架构设计。 📖 项目简介 ------ [](#-项目简介) GPAdmin-api 是一个基于 Laravel 12 构建的企业级 API 框架，采用模块化架构，提供用户管理、权限管理、日志管理等核心功能，支持快速开发 RESTful API 服务。 🚀 技术栈 ----- [](#-技术栈) - **PHP** >= 8.3 - **Laravel** 12.0 - **Laravel Sanctum** - API 认证 - **Laravel Modules** - 模块化架构 - **MySQL** - 数据库 - **IP2Region** - IP 地址查询 ✨ 核心功能 ------ [](#-核心功能) - ✅ 用户登录 / 授权 - ✅ 管理员列表 - ✅ 用户管理（支持审核流程） - ✅ 日志管理（操作日志、登录日志、审计日志、通用日志） - ✅ 通知管理（公告、站内信） - ✅ 权限管理 - ✅ 系统参数配置 - ✅ 文件管理 - ✅ 数据字典 🛠️ 环境要求 ------- [](#️-环境要求) - PHP >= 8.3 - Composer - MySQL >= 5.7 - PHP 扩展：fileinfo, mbstring, pdo\_mysql 📦 安装步骤 ------ [](#-安装步骤) ### 1. 安装项目 [](#1-安装项目) ``` composer create-project siushin/GPAdmin-api ``` ### 2. 配置环境 [](#2-配置环境) ``` # 复制环境配置文件 cp .env.example .env # 生成应用密钥 php artisan key:generate # 创建符号链接 php artisan storage:link ``` > **注意**：需要确保 php.ini 中 `symlink` 函数未被禁用。 ### 3. 配置数据库 [](#3-配置数据库) 编辑 `.env` 文件，配置数据库连接： ``` DB_CONNECTION=mysql DB_HOST=127.0.0.1 DB_PORT=3306 DB_DATABASE=laravel_api DB_USERNAME=root DB_PASSWORD= ``` ### 4. 创建数据库 [](#4-创建数据库) 在 MySQL 中创建数据库： ``` CREATE DATABASE laravel_api CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; ``` ### 5. 初始化系统 [](#5-初始化系统) ``` # 运行迁移和填充（会自动执行） composer install # 或手动执行 # 初次执行 php artisan migrate --seed # 清空所有并重新执行 php artisan migrate:fresh --seed ``` **默认管理员账号：** `admin` / `admin` ⚠️ 注意事项 ------- [](#️-注意事项) > ⚠️ **重要提示**：执行 `composer create-project` 或 `composer install` 都会执行 **清空** 表并 **重新填充** 数据（`php artisan migrate:fresh --seed`）。如有重要数据，请自行备份。 ⚠️⚠️⚠️注意事项 ---------- [](#️️️注意事项) > 注意：执行命令 `composer create-project` 或 `composer install` 都会执行 **清空** 表并 **重新填充** 数据 `php artisan migrate:fresh --seed`。如有重要数据，请自行备份。 📚 文档链接 ------ [](#-文档链接) - [API 接口文档](https://s.apifox.cn/9e462aa5-5078-455c-b631-75b9d9e2a303) - [开发文档](https://github.com/siushin/GPAdmin-doc) - [前端项目](https://github.com/siushin/GPAdmin) 💻 常用命令 ------ [](#-常用命令) ### 开发 [](#开发) ``` # 启动开发服务器（包含服务器、队列、日志、前端构建） composer run dev # 启动 Web 服务器 php artisan serve # 启动队列监听 php artisan queue:listen # 查看日志 php artisan pail ``` ### 数据库 [](#数据库) ``` # 运行迁移 php artisan migrate # 回滚迁移 php artisan migrate:rollback # 运行填充 php artisan db:seed # 重置数据库并填充 php artisan migrate:fresh --seed ``` ### 测试 [](#测试) ``` # 运行测试 composer test # 或 php artisan test ``` ### 代码规范 [](#代码规范) ``` # 代码格式化（使用 Laravel Pint） ./vendor/bin/pint ``` ### 其他命令 [](#其他命令) ``` # 更新 Composer 的自动加载文件 composer dump-autoload # 启用 API 路由 php artisan install:api # 发布 CORS（跨源资源共享）配置 php artisan config:publish cors # 创建系统枚举类（示例） php artisan make:enum DictionaryCategoryEnum php artisan make:enum OrganizationTypeEnum ``` 目录结构 ---- [](#目录结构) 目录名描述CasesEnums枚举类，一般以 `Enum` 结尾Funcs助手函数，分以 `Lara` 开头的基于Laravel的助手函数，以及以 `Func`开头的常用助手函数（方便全局搜索）Traits特征，没有明显命名规范，自行查询源码或文档❓ 常见问题 ------ [](#-常见问题) ### 413 Request Entity Too Large [](#413-request-entity-too-large) 处理方案： 1. **调整 Nginx 配置** - 配置文件中增加或修改 `client_max_body_size` 指令 - 例如，将大小设置为 100MB：`http { client_max_body_size 100m; }` 2. **调整 PHP 配置** - 调整 PHP 的 `upload_max_filesize` 和 `post_max_size` 配置项 - `upload_max_filesize = 100M` - `post_max_size = 100M` 📁 模块说明 ------ [](#-模块说明) 项目采用模块化架构，主要模块包括： - **Base** - 基础模块（用户、管理员、日志、通知等） - **Sms** - 短信模块 📂 目录结构说明 -------- [](#-目录结构说明) 项目目录结构遵循 Laravel 规范，模块化代码位于 `Modules/` 目录下： 目录名描述Cases案例/示例代码Enums枚举类，一般以 `Enum` 结尾Funcs助手函数，分以 `Lara` 开头的基于 Laravel 的助手函数，以及以 `Func` 开头的常用助手函数（方便全局搜索）Traits特征类，没有明显命名规范，自行查询源码或文档📖 参考资料 ------ [](#-参考资料) - [overtru 相关扩展包](https://packagist.org/packages/overtrue/) 🧑🏻‍💻 关于作者 --------- [](#‍-关于作者) 多年开发经验，具有丰富的前、后端软件开发经验~ 👤 作者： 💻 个人博客： 📮 邮箱：[](mailto:siushin@163.com) 💡 反馈交流 ------ [](#-反馈交流) 在使用过程中有任何想法、合作交流，请加我微信 `siushin` （备注 github ）： [![添加我微信备注「GPAdmin」](/public/images/siushin-WeChat.jpg)](/public/images/siushin-WeChat.jpg) ☕️ 打赏赞助 ------- [](#️-打赏赞助) 如果你觉得知识对您有帮助，可以请作者喝一杯咖啡 ☕️ [![微信收款码](/public/images/siushin-WechatPay.jpg)](/public/images/siushin-WechatPay.jpg)[![支付宝收款码](/public/images/siushin-Alipay.jpg)](/public/images/siushin-Alipay.jpg) ### Health Score 19 — LowBetter than 10% of packages Maintenance57 Moderate activity, may be stable Popularity2 Limited adoption so far Community6 Small or concentrated contributor base Maturity11 Early-stage or recently created project Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/86f3f1827707c22e3a941ff62acd6d9c035b59caa8f5a4ace163a242dff16924?d=identicon)[siushin](/maintainers/siushin) --- Top Contributors [![siushin](https://avatars.githubusercontent.com/u/103615249?v=4)](https://github.com/siushin "siushin (158 commits)") --- Tags apilaravellaravel-api ### Embed Badge ![Health badge](/badges/siushin-laravel-api/health.svg) ``` [![Health](https://phpackages.com/badges/siushin-laravel-api/health.svg)](https://phpackages.com/packages/siushin-laravel-api) ``` ### Alternatives [stripe/stripe-php Stripe PHP Library 4.0k143.3M475](/packages/stripe-stripe-php)[twilio/sdk A PHP wrapper for Twilio's API 1.6k92.9M270](/packages/twilio-sdk)[knplabs/github-api GitHub API v3 client 2.2k15.8M186](/packages/knplabs-github-api)[facebook/php-business-sdk PHP SDK for Facebook Business 90121.9M33](/packages/facebook-php-business-sdk)[microsoft/microsoft-graph The Microsoft Graph SDK for PHP 65723.5M95](/packages/microsoft-microsoft-graph)[meilisearch/meilisearch-php PHP wrapper for the Meilisearch API 73813.7M114](/packages/meilisearch-meilisearch-php) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)