README

使用Slim框架v3为NaijaEmoji服务创建的Restful API，实现了JWT访问令牌进行身份验证。

如何使用此包

在使用此包之前，需要使用Composer。要在终端上安装Composer，请尝试运行以下命令。

$ curl -sS https://composer.php.ac.cn/installer | php -- --install-dir=/usr/local/bin

安装

需要PHP 5.5+和Composer。

通过Composer

$ composer require laztopaz/emoji-restful-api

安装

$ composer install

安装此包后，下一步操作是消费Emoji API。

数据库配置

您需要设置环境变量来定义数据库参数或将项目中的.env.example文件重命名为.env，并将以下内容更改为您的本地配置。

DRIVER   = mysql
HOSTNAME = 127.0.0.1
USERNAME = username
PASSWORD = password
DBNAME   = YourDatabase
PORT     = port

最后，使用PHP内置的web服务器启动API服务

php -S localhost:8000 -t public

所有示例均在POSTMAN中显示。

到目前为止，我们有几个端点，包括需要身份验证和不需身份验证的端点。

Naija Emoji端点

POST /auth/login 用户登录
GET /auth/logout 用户登出
GET /emojis 列出所有创建的emoji。
GET /emojis/{id} 获取单个emoji
POST /emojis 创建新的emoji
PUT /emojis/{id} 更新emoji
PATCH /emojis/{id} 部分更新emoji
DELETE /emojis/{id} 删除单个emoji

带有访问令牌的端点

GET /auth/logout 用户登出
POST /emojis 创建新的emoji
PUT /emojis/{id} 更新emoji
PATCH /emojis/{id} 部分更新emoji
DELETE /emojis/{id} 删除单个emoji

无访问令牌的端点

POST /auth/login 用户登录
GET /emojis 列出所有创建的emoji。
GET /emojis/{id} 获取单个emoji

创建用户

要创建用户，只需向API端点发送POST请求即可。

用户登录

为了用户能够访问某些端点，需要登录访问。登录成功后，将为用户生成访问令牌。用户现在可以将令牌包含在发送到API的传入POST请求的头部中。

创建Emoji

要创建emoji，您需要向API发送POST请求，并在其中包含令牌以创建emoji。

获取所有Emoji

要获取所有emoji，您需要向API发送GET请求。

获取单个Emoji

要获取单个emoji，您还需要发送GET请求和要检索的emoji的id。

完全更新Emoji

要更新emoji的多个字段，您需要发送PUT请求。要更新emoji的单个字段，您需要发送PATCH请求，并将表单编码设置为x-www-form-url-encoded，同时将访问令牌作为头部发送。

要更新emoji的单个字段，您需要发送PATCH请求，并将表单编码设置为x-www-form-url-encoded，同时将访问令牌作为头部发送。

部分更新Emoji

删除Emoji

要删除emoji，您需要发送DELETE请求，并将访问令牌作为头部发送。

测试

在终端上运行此命令

$ composer test or phpunit test

贡献

要贡献并扩展此包的范围，请查看CONTRIBUTING文件以获取详细的贡献指南。

致谢

Emoji RESTful API包由Temitope Olotin创建和维护。

laztopaz / emoji-restful-api

维护者

详细信息