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許可下獲得許可 - 有關詳細信息，請參見許可證文件。