PHPackages                             mitirrli/laravel-skeleton - 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. mitirrli/laravel-skeleton

ActiveProject[API Development](/categories/api)

mitirrli/laravel-skeleton
=========================

A Laravel starter project template.

1.0.0(5y ago)15MITPHPPHP ^8.0

Since Apr 18Pushed 4y ago1 watchersCompare

[ Source](https://github.com/Mitirrli/laravel-skeleton)[ Packagist](https://packagist.org/packages/mitirrli/laravel-skeleton)[ RSS](/packages/mitirrli-laravel-skeleton/feed)WikiDiscussions master Synced 2d ago

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

Laravel API 基础模板
================

[](#laravel-api-基础模板)

开箱即用的 Laravel API 基础结构。

> 自己用的哈，仅供参考，不提供咨询解答服务。

特点
--

[](#特点)

- 内置 laravel/sanctum 的授权机制；
- 高度完善的控制器、模型、模块模板；
- 集成常用基础扩展；
- 内置模型通用高阶 Traits 封装;
- 自动注册 Policies；
- 内置用户系统和基础接口；
- 内置管理后台接口；

安装
--

[](#安装)

1. 创建项目

```
$ composer create-project mitirrli/laravel-skeleton -vvv
```

2. 创建配置文件

```
$ cp .env.example .env
```

3. 创建数据表和测试数据

```
$ php artisan migrate --seed
```

> 这一步将会创建管理员账号 `username:admin / password:changeThis!!` 和一个 demo 设置项。

然后访问 `http://laravel-skeleton.test/api/settings` 将会看到演示的设置项信息。

使用
--

[](#使用)

### 创建新模块

[](#创建新模块)

```
$ php artisan make:model Post -a --api
# Model created successfully.
# Factory created successfully.
# Created Migration: 2020_09_22_150134_create_posts_table
# Seeder created successfully.
# Controller created successfully.
```

### 模型关系加载

[](#模型关系加载)

我们可以在前端请求时动态决定接口返回哪些模型关系，例如 `User` 模型有一个 `posts` 关系，我们的用户列表控制器如下 `UserController@index`:

```
public function index(Request $request)
{
    $users = User::filter($request->all())
        ->with($request->relations())   // latest()
        ->paginate($request->get('per_page', 20));

    return $users;
}
```

默认不会返回 `posts` 关系，当前端请求的 URL 如下时将会返回：

```
http://laravel-skeleton.test/api/users?with=posts

```

如果期望返回指定的字段，则可以这样构造 URL：

```
http://laravel-skeleton.test/api/users?with=posts:id,title,updated_at

```

这样返回结果中 `posts` 结果将只包含 `id,title,updated_at` 。

> 注意：这里不能省略掉关系的 id 字段，否则关系将无法正常加载。

### 模型搜索功能

[](#模型搜索功能)

项目已经内置的基本的搜索支持，您只需要在模型引入 `App\Traits\Filterable`，然后配置 `filterable`属性即可：

```
use use App\Traits\Filterable;
use Illuminate\Database\Eloquent\Model;

class Post extends Model
{
    use Filterable;

    protected $filterable = [
        'user_id', 'category_id', 'version',
    ];
}
```

控制器开启搜索功能，只需要调用 `filter()` 方法即可：

```
public function index(Request $request)
{
    $posts = Post::with($request->relations())
                ->latest()
                ->filter() // paginate($request->get('per_page'));

    return $posts;
}
```

URL 中只需要传递对应的参数值即可：

```
http://laravel-skeleton.test/api/posts?with=user:id,username&user_id=123&category_id=4
// &user_id=123&category_id=4

```

#### 自定义搜索

[](#自定义搜索)

默认使用相等查询，如果需要自定义搜索字段，直接在模型中添加 `filterXXX` 方法实现，比如我们想实现文章标题模糊查询：

```
public function filterTitle($query, $keyword)
{
    $query->where('title', 'like', "%{$keyword}%");
}
```

然后 URL 上使用 `title=关键字` 就能实现模糊查询了。

> 当然，你也可以定义模型中不存在的字段。

### 静默更新

[](#静默更新)

我们有时候会想更新数据库中的记录，但是不希望触发 `updated_at` 更新，则可以在模型引入 `App\Traits\QuietlySave` 或者 `App\Traits\QuietlyUpdate` 这两个 trait：

```
// App\Traits\QuietlySave
User::saveQuietly([...]);
// or
// App\Traits\QuietlyUpdate
User::updateQuietly([...]);
```

### 内置接口

[](#内置接口)

#### 用户登录（获取 token）

[](#用户登录获取-token)

##### POST /api/login

[](#post-apilogin)

- Request (`application/json`)

```
{
  "username": "admin",
  "password": "changeThis!!"
}
```

- Response 200 (application/json)

```
{
    "token_type": "bearer",
    "token":"oVFV407i4jSTxjFO2tNxzh8lDaxVLbIkZZiDwjgMSYhvvkbUUXw8y0XgeYtxLAp4paznq0oxSMDdXmco"
}
```

#### 用户注册

[](#用户注册)

##### POST /api/register

[](#post-apiregister)

- Request (`application/json`)

```
{
   "username": "demo",
   "password": "123456"
}
```

- Response 200 (`application/json`)

```
{
    "token_type": "bearer",
    "token":"oVFV407i4jSTxjFO2tNxzh8lDaxVLbIkZZiDwjgMSYhvvkbUUXw8y0XgeYtxLAp4paznq0oxSMDdXmco"
}
```

#### 登出

[](#登出)

##### POST /api/logout

[](#post-apilogout)

- Request (`application/json`) + Headers

```
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1...

```

- Response 204

#### 获取当前登录用户

[](#获取当前登录用户)

##### GET /api/user

[](#get-apiuser)

- Request (`application/json`) + Headers

```
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1...

```

- Response 200 (`application/json`)

```
{
  "id": "0892b118-856e-4a15-af0c-66a3a4a28eed",
  "username": "admin",
  "name": "超级管理员",
  "real_name": null,
  "avatar": "\/img\/default-avatar.png",
  "email": null,
  "gender": "none",
  "phone": null,
  "birthday": null,
  "status": "active",
  "cache": [],
  "properties": null,
  "settings": [],
  "is_admin": true,
  "last_active_at": null,
  "last_refreshed_at": null,
  "frozen_at": null,
  "status_remark": null,
  "email_verified_at": null,
  "created_at": "2020-03-17T09:37:45.000000Z",
  "updated_at": "2020-03-17T09:37:45.000000Z",
  "deleted_at": null
}
```

#### 获取全局设置

[](#获取全局设置)

##### GET /api/settings

[](#get-apisettings)

- Response 200 (`application/json`)

```
{
    "demo": {
        "status":"it works!"
    }
}
```

License
-------

[](#license)

MIT

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity5

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity57

Maturing project, gaining track record

 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.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

1850d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/ae6fcc430a0d8c57a965a23d47096d0fb28660a2e958c3f9f45f27e7f444a535?d=identicon)[Mitirrli](/maintainers/Mitirrli)

---

Top Contributors

[![Mitirrli](https://avatars.githubusercontent.com/u/50682346?v=4)](https://github.com/Mitirrli "Mitirrli (8 commits)")

---

Tags

apilaravelSPA

###  Code Quality

TestsPHPUnit

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/mitirrli-laravel-skeleton/health.svg)

```
[![Health](https://phpackages.com/badges/mitirrli-laravel-skeleton/health.svg)](https://phpackages.com/packages/mitirrli-laravel-skeleton)
```

###  Alternatives

[bagisto/bagisto

Bagisto Laravel E-Commerce

26.2k161.6k7](/packages/bagisto-bagisto)[openai-php/laravel

OpenAI PHP for Laravel is a supercharged PHP API client that allows you to interact with the Open AI API

3.7k7.6M74](/packages/openai-php-laravel)[unopim/unopim

UnoPim Laravel PIM

9.4k1.8k](/packages/unopim-unopim)[aimeos/aimeos-headless

Aimeos headless ecommerce system

2.5k2.3k](/packages/aimeos-aimeos-headless)[nickurt/laravel-postcodeapi

Universal PostcodeApi for Laravel 11.x/12.x/13.x

97221.2k](/packages/nickurt-laravel-postcodeapi)[mozex/anthropic-laravel

Anthropic PHP for Laravel is a supercharged PHP API client that allows you to interact with the Anthropic API

71226.4k1](/packages/mozex-anthropic-laravel)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)