使用 Laravel Rest Api 轻松生成 Apis

Laravel  /  管理员 发布于 1年前   453

Laravel Rest Api 是一个软件包，旨在帮助你以强大的方式生成 Api，而无需重组代码库。它集成了以下功能：

完整的 REST API
自动门集成
支持所有 Laravel 关系
完全可定制
全程安全
复杂的过滤操作
使用一个端点更改多个模型
支持自定义的自动文档生成

安装 Laravel Rest Api

使用 composer 安装软件包：

composer require lomkit/laravel-rest-api

要开始使用该软件包，您可以使用快速入门命令，围绕用户模型设置全面支持的应用程序接口：

php artisan rest:quick-start

该命令将生成 UserResource 和 UsersController 类，并将它们注册到 api.php 路由文件中。

这样就大功告成了！端点已完全注册，

请使用 php artisan route:list 命令查看：

+---------+--------------------------------+----------------------+
| Method  | URI                            | Name                 |
+---------+--------------------------------+----------------------+
| GET     | api/users                      | api.users.detail     |
| POST    | api/users/search               | api.users.search     |
| POST    | api/users/actions/{action}     | api.users.operate    |
| POST    | api/users/mutate               | api.users.mutate     |
| DELETE  | api/users                      | api.users.destroy    |
+---------+--------------------------------+----------------------+

要了解这些新注册的端点的功能，请查看文档的端点部分。

https://laravel-rest-api.lomkit.com/endpoints/search

下面是搜索端点可能性的一个示例：

// (POST) api/posts/search
{
    "scopes": [
        {"name": "withTrashed", "parameters": [true]}
    ],
    "filters": [
        {
            "field": "id", "operator": ">", "value": 1, "type": "or"
        },
        {
            "nested": [
                {"field": "user.id", "operator": "<", "value": 2},
                {"field": "id", "operator": ">", "value": 100, "type": "or"}
            ]
        }
    ],
    "sorts": [
        {"field": "user_id", "direction": "desc"},
        {"field": "id", "direction": "asc"}
    ],
    "selects": [
        {"field": "id"}
    ],
    "includes": [
        {
            "relation": "posts",
            "filters": [
                 {"field": "id", "operator": "in", "value": [1, 3]}
            ],
            "limit": 2
        },
        {
            "relation": "user",
            "filters": [
                {
                    "field": "languages.pivot.boolean",
                    "operator": "=",
                    "value": true
                }
            ]
        }
    ],
    "aggregates": [
        {
            "relation": "stars",
            "type": "max",
            "field": "rate",
            "filters": [
                {"field": "approved", "value": true}
            ]
        }
    ],
    "instructions": [
      {
        "name": "odd-even-id",
        "fields": [
          { "name": "type", "value": "odd" }
        ]
      }
    ],
    "page": 2,
    "limit": 10
}

最后

Laravel Rest Api 软件包和文档可在 GitHub 上的 lomkit/laravel-rest-api 找到。

https://github.com/lomkit/laravel-rest-api