weevely api

？下载

• V1.0最新 - 下载

⚓要求

• PHP 8.0.7
• mysql 6.x / mariadb 10.x
• 作曲家2.x

MACOS安装：
您可以通过Homebrew轻松安装这些：

brew install php mysql composer

Windows安装：

1. 下载并安装最新版本的XAMPP。它将同时安装PHP和Mariadb。每当您想使用数据库时，打开XAMPP并开始MySQL进程。要访问phpMyAdmin，请同时启动Apache和MySQL进程，请单击MySQL旁边的Admin按钮
2. 下载并安装最新版本的作曲家。 PHP依赖管理器。

？本地运行API

如果需要，您可以在服务器上轻松托管此API。但是，如果您只想处理官方使用的数据，则可以跳过此步骤。

要托管API，只需按照以下步骤操作：

1. 检查要求☝️
2. 下载最新版本
3. 在您的终端中打开文件夹并运行composer install
4. 创建您的database
5. 创建.env文件并将其相应地填充到.env.example文件
6. 运行php artisan migrate以用所需的表填充数据库
7. 如果要在数据库中添加一些数据进行测试，请运行php artisan db:seed
8. 使用php artisan serve启动API服务器

？ API参考

授权模块

行动	要求	方法	要求
登记	/api/auth/register	POST	数据
登入	/api/auth/signin	POST	数据
登出	/api/auth/signout	POST	承载令牌
重置密码	/api/auth/reset-password	POST	数据
更改密码	/api/auth/reset-password/{token}	POST	数据，令牌
删除请求	/api/auth/reset-password/{token}/remove	GET	令牌
刷新令牌	/api/auth/refresh	GET	承载令牌
获取用户	/api/auth/me	GET	承载令牌

用户模块

行动	要求	方法	要求
更新数据	/api/users/me	PATCH	载体令牌，数据
上传化身	/api/users/me/avatar	POST	载体令牌，数据

日历和事件模块

动作	要求	方法	要求
获取我的日历	/api/calendars/my/{type}	GET	载体令牌，类型
创建日历	/api/calendars/my	POST	载体令牌，数据（可选）
获取日历	/api/calendars/{calendar_id}	GET	载体令牌，calendar_id
更新日历	/api/calendars/{calendar_id}	PATCH	载体令牌，calendar_id，数据
删除日历	/api/calendars/{calendar_id}	DELETE	载体令牌，calendar_id
共享日历	/api/calendars/{calendar_id}/share	POST	载体令牌，calendar_id，用户（json字符串）
隐藏日历	/api/calendars/{calendar_id}/hide	POST	载体令牌，calendar_id
获取活动	/api/calendars/{calendar_id}/events	GET	载体令牌，calendar_id
创建事件	/api/calendars/{calendar_id}/events	POST	载体令牌，calendar_id，数据（可选）
更新事件	/api/calendars/{calendar_id}/events/{event_id}	PATCH	载体令牌，calendar_id，数据
删除事件	/api/calendars/{calendar_id}/events/{event_id}	DELETE	载体令牌，calendar_id
添加假期	/api/calendars/{calendar_id}/holidays	POST	携带者令牌，calendar_id，数据（国家，年）

？祝你有美好的一天！

不要忘记与Next.js一起检查
还请查看我的其他项目并访问我的网站！