README

Laravel REST API为应用程序提供了一种通过发送和接收JSON数据与您的应用程序交互的接口。

安装

您可以通过composer安装此包

composer require birim/laravel-rest-api

您可以使用以下命令发布配置文件

php artisan vendor:publish --tag=laravel-rest-api

配置

首先在配置文件中定义您的REST API端点。端点包含一个标签并指向一个Eloquent类。例如

<?php

return [
    'endpoints' => [
        'users' => App\Models\User::class
    ]
];

路由

配置完成后，可以调用REST API端点。所有端点都以laravel-json开头。

目前，提供了三种类型的端点：列表、分页和搜索。

所有可用端点都可以通过/laravel-json访问

响应

返回的数据可以在Eloquent模型文件中进行配置。$restApiAttributes属性定义了应返回的所有属性。如果没有此属性，将返回所有属性。如果您想排除某些属性，可以使用$restApiHidden属性。

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class ExampleModel extends Model
{
    public $restApiAttributes = [
        'name',
        'email'
    ];

    public $restApiHiddenAttributes = [
        'name'
    ];

更新日志

有关最近更改的更多信息，请参阅更新日志。

许可证

此项目和Laravel框架是开源软件，许可协议为MIT许可证。

单元 / laravel-rest-api

维护者

详细信息

README

安装

配置

路由

响应

更新日志

许可证