README

此包为CMS提供核心后端功能，用于上传媒体（图像）文件并将它们组织到文件夹中。

安装

此包可以通过Composer安装。

composer require optimuscms/media

在Laravel 5.5及以上版本中，此包将自动注册服务提供者。

在Laravel 5.4中，您必须安装此服务提供者

// config/app.php
'providers' => [
    ...
    Optimus\Media\MediaServiceProvider::class,
    ...
];

API路由

API遵循标准的RESTful约定，响应以JSON格式返回。提供了适当的HTTP状态码，应使用这些状态码检查操作的结果。

文件夹

• 列出文件夹
• 获取文件夹
• 创建文件夹
• 更新文件夹
• 删除文件夹

媒体项

• 列出媒体项
• 获取媒体项
• 创建媒体项
• 更新媒体项
• 删除媒体项

列出文件夹

GET /admin/api/media-folders

列出所有可用的文件夹，可以将媒体项添加到这些文件夹中。

参数

示例响应

[
    {
        "id": 12,
        "parent_id": null, 
        "name": "Product Images", 
        "created_at": "2017-12-24 09:36:23",
        "updated_at": "2017-12-25 10:15:12"
    },
    {
        "id": 13,
        "parent_id": 12, 
        "name": "Product Thumbnails", 
        "created_at": "2019-02-19 09:36:23",
        "updated_at": "2019-02-19 09:36:23"
    }
]

获取文件夹

GET /admin/api/media-folders/{id}

检索特定文件夹的详细信息。

参数

示例响应

{
    "id": 12,
    "parent_id": null, 
    "name": "Product Images", 
    "created_at": "2017-12-24 09:36:23",
    "updated_at": "2017-12-25 10:15:12"
}

更新文件夹

PUT/PATCH /admin/api/media-folders/{id}

更新文件夹的详细信息。

参数

示例响应

{
    "id": 12,
    "parent_id": null, 
    "name": "Product Images", 
    "created_at": "2017-12-24 09:36:23",
    "updated_at": "2017-12-25 10:15:12"
}

创建文件夹

POST /admin/api/media-folders

创建一个新的文件夹。

参数

示例响应

{
    "id": 12,
    "parent_id": null, 
    "name": "Product Images", 
    "created_at": "2017-12-24 09:36:23",
    "updated_at": "2017-12-25 10:15:12"
}

删除文件夹

DELETE /admin/api/media-folders/{id}

删除文件夹。

参数

示例响应

如果成功，HTTP状态码将为204。

列出媒体项

GET /admin/api/media

列出可用的媒体项。

参数

示例响应

[
    {
        "id": 356,
        "folder_id": 12, 
        "name": "My Image", 
        "file_name": "my_image.jpg",
        "disk": "local",
        "mime_type": "image/jpeg", 
        "size": 102400,
        "created_at": "2017-12-24 09:36:23",
        "updated_at": "2017-12-25 10:15:12"
    },
    {
        "id": 513,
        "folder_id": 4, 
        "name": "Landscape", 
        "file_name": "landscape.png",
        "disk": "local",
        "mime_type": "image/png", 
        "size": 219462,
        "created_at": "2019-02-19 09:36:23",
        "updated_at": "2019-02-19 09:36:23"
    }
]

获取媒体项

GET /admin/api/media/{id}

检索特定媒体项的详细信息。

参数

示例响应

{
    "id": 513,
    "folder_id": 4, 
    "name": "Landscape", 
    "file_name": "landscape.png",
    "disk": "local",
    "mime_type": "image/png", 
    "size": 219462,
    "created_at": "2019-02-19 09:36:23",
    "updated_at": "2019-02-19 09:36:23"
}

更新媒体项

PUT/PATCH /admin/api/media/{id} 

更新单个媒体项的详细信息。

参数

示例响应

{
    "id": 513,
    "folder_id": 4, 
    "name": "Landscape", 
    "file_name": "landscape.png",
    "disk": "local",
    "mime_type": "image/png", 
    "size": 219462,
    "created_at": "2019-02-19 09:36:23",
    "updated_at": "2019-02-19 09:36:23"
}

创建媒体项

POST /admin/api/media

创建并存储一个新的媒体项。

参数

示例响应

{
    "id": 513,
    "folder_id": 4, 
    "name": "Landscape", 
    "file_name": "landscape.png",
    "disk": "local",
    "mime_type": "image/png", 
    "size": 219462,
    "created_at": "2019-02-19 09:36:23",
    "updated_at": "2019-02-19 09:36:23"
}

删除媒体项

DELETE /admin/api/media/{id}

删除媒体项。

参数

示例响应

如果成功，HTTP状态码将为204。

许可

MIT许可（MIT）。有关更多信息，请参阅许可文件。