django rest starter kit

Django休息框架入门套件

这是用于Django Rest框架（DRF）项目的入门模板，旨在为API开发中通常需要的基础提供坚实的基础。

特征

• 基于令牌的身份验证：使用基于令牌的身份验证保护API端点。
• Swagger API文档：使用Swagger UI自动生成交互式API文档。
• 用户管理系统：实施用户注册，登录，注销和密码重置功能。
• 权限和角色：定义用户角色和权限控制对API端点的访问。
• 电子邮件通知：设置与用户相关事件（例如注册和密码重置）的电子邮件通知。
• 利率限制：通过实施限制速率来防止滥用API端点。
• 文件上传：带有可自定义存储后端的文件上传（例如，图像，文档）。
• 缓存：通过缓存来提高API性能，以获取常见数据。
• 背景任务：使用芹菜和消息经纪人对背景任务进行异步执行。
• 监视和记录：通过记录和监视工具监视应用程序性能和跟踪错误。

用法

1. 克隆这个存储库：

   git clone https://github.com/hossainchisty/django-rest-starter-kit.git

2. 安装依赖项：

   pip install -r requirements.txt

3. 自定义设置：

   • 在settings.py中配置数据库设置。
   • 设置用于发送通知的电子邮件配置。
   • 配置令牌身份验证设置。
   • 根据您的应用程序要求自定义权限和角色。

4. 迁移数据库：

   python manage.py migrate

5. 运行开发服务器：

   python manage.py runserver

6. 访问API文档：

   打开浏览器并导航到http://127.0.0.1:8000/swagger/查看Swagger UI生成的交互式API文档。

7. 开始构建API端点：

   • 在urls.py中定义您的API端点。
   • 分别在views.py和serializers.py中为您的API资源实现视图和序列化。
   • 使用令牌身份验证保护端点，并根据需要定义权限。

测试

运行单元测试和集成测试，以确保API的可靠性和稳定性：

python manage.py test 

贡献

欢迎捐款！如果您有改进或新功能的建议，请打开问题或提交拉动请求。

执照

该项目已在Apache -2.0许可下获得许可 - 有关详细信息，请参见许可证文件。