loveduckie / silverstripe-image-uploader-api
一个Silverstripe模块,用于公开API以启用远程图像上传。
5.x-dev
2024-09-25 14:23 UTC
Requires
- silverstripe/admin: ^2.0
- silverstripe/framework: ^5.0
Requires (Dev)
README
silverstripe-image-uploader-api
本模块使您能够公开一个安全且RESTful的API,用于远程上传图像资源,并将它们作为文件(及其关联的数据库记录)存储在Silverstripe中。有关用法,请参阅下面的文档。
需求
- Silverstripe ^5.0
安装
在此处添加一些安装说明,使用1行composer复制粘贴很有用。以下是一个创建新模块项目的composer命令。请确保您已阅读'发布模块'指南,并更新您的module的composer.json以指定您的代码为SilverStripe模块。
#!/usr/bin/env bash
composer require loveduckie/silverstripe-image-uploader-api
注意:当您完成模块后,将其提交到Packagist或将其作为VCS存储库添加到项目的composer.json中,指向私有存储库URL。
许可证
见许可证
文档
配置
如果您的模块使用SilverStripe的config API,建议在此处提供一个示例配置,这将使模块能够直接运行并让用户了解可能的配置选项。
尽可能提供yaml代码示例。
-- name: imageuploaderapi-configuration -- LoveDuckie\SilverStripe\ImageUploaderApi: api_token: ACZ4CAUSzjAwXcfm api_content_type: application/json
维护者
- Luc Shelton lucshelton@gmail.com
错误追踪
错误在此存储库的问题部分跟踪。在提交问题之前,请阅读现有问题以确保您的独特性。
如果问题看起来像是一个新的错误
- 创建一个新的问题
- 描述重现您的问题所需的步骤和预期结果。单元测试、屏幕截图和屏幕录制可能在这里有所帮助。
- 尽可能详细地描述您的环境:SilverStripe版本、浏览器、PHP版本、操作系统、任何已安装的SilverStripe模块。
请直接向模块维护者报告安全问题。请不要在错误跟踪器中报告安全问题。
开发和贡献
如果您想为模块做出贡献,请确保您发起了一个pull请求并与模块维护者进行讨论。