dev-master 2020-09-11 15:16 UTC

This package is auto-updated.

Last update: 2024-09-11 23:43:55 UTC


README

Packagist Pre Release TravisCI Scrutinizer Code Quality Gittip License Yii

这是一个项目模板,通过实现常见的API端点(如注册和身份验证)来减少编写RESTful JSON API的冗余工作,使开发者能够专注于编写核心应用程序的业务逻辑,而不是反复实现相同的组件。该项目基于Yii Framework 2(Yii2)构建,提供了一个易于扩展的基本 API框架,并实现了一个可轻松扩展的基本API。

提供什么?

默认提供以下功能:

  • 使用HMAC+HKDF进行身份验证
  • 注册
  • 为已验证和未验证的用户提供密码重置功能

还提供以下附加功能:

  • 通过OTP代码进行双因素身份验证 + 管理API端点
  • 可配置速率限制
  • 通过libsodium支持加密API会话
  • 支持翻译
  • 使用Docker进行开发

文档

有关如何设置、配置、扩展和使用此框架的信息,请参阅docs文件夹中的文档。

如何贡献

您可以通过向此存储库提交新问题或拉取请求,或向yii2-api-rest-components提交,贡献核心API的开发。如果您正在寻找可以贡献的内容,请考虑以下想法:

  • 翻译
  • 实现API中常见的新的API端点

许可证

有关许可证信息,请参阅LICENSE.md