django rest starter kit

Django Rest 프레임 워크 스타터 키트

이것은 Django Rest Framework (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 라이센스에 따라 라이센스가 부여됩니다. 자세한 내용은 라이센스 파일을 참조하십시오.