글 작성 이유
저는 주로 node.js를 활용하여 백엔드 개발을 했습니다.
프로그라피 라는 동아리에서도 node 멘티로서 개발을 하다가 친한 형의 권유로 다음 기수에는 django 멘티로 참여하게 되었습니다.
django에 관심은 있었지만 해본적이 없어서 급하게 공부하여 사전과제를 수행하고
Fit이 맞는 사람들과 토이프로젝트 매칭 사이트 Fit-ple이란 프로젝트에 참여하게 되었습니다.
django가 처음이라 초반에 시작하는데 많은 삽질과 스트레스가 있었습니다.
그 경험을 기반으로 drf를 활용한 api 개발을 정리하려고 합니다.
블로그 작성이 처음이라 틀린점이나 의견 있으시면 바로바로 수정하겠습니다!
DRF를 사용한 이유
DRF는 Django Rest Framework의 약자입니다
DRF는 영어 뜻 그대로 django로 rest api를 만들 수 있게 해주는 프레임워크입니다.
저희 팀원은 React를 활용하여 프론트 개발을 진행했기 때문에 DRF를 활용하여 백엔드 서버를 구축하였습니다.
DRF 사용법은 공식문서를 참고하시면 됩니다.
프로젝트 기본 세팅
저는 기본적으로 mac에서 python 3.6.8 버전을 활용하여 개발하였습니다.
- 가상환경 설정
python3 -m venv django_starter
## 파이썬 가상환경 세팅입니다.
source django_starter/bin/activate
## 이 후 작업은 위의 방식을 가상환경에 접속하여 진행해야 됩니다. - 기본적으로 필요한 package 설치
pip install django
pip install djangorestframework- 프로젝트 세팅
django-admin startproject api_server
## 여기서 api_server는 메인 프로젝트 명입니다. 자유롭게 변경 가능합니다.
cd api_server
python manage.py startapp accounts
## 다음 글에서 테스트 해볼 회원 관련 기능을 진행할 app 입니다.users라는 app을 생성하였으니 메인 프로젝트에 users를 추가해줘야 합니다.
위치는 api_server/settings.py의 INSTALLED_APPS에 아래와 같이 추가해주면 됩니다. (추가적으로 rest_framework도 작성하겠습니다.)
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
# 아래부터 추가된 부분
'rest_framework',
'accounts',
]
- 테스트 실행
아직 많은 것을 작성하지 않았지만 제대로 생성이 된 지 확인해보기 위해 api 서버를 실행해보겠습니다.
python manage.py migrate
## model 변경 사항을 db에 업데이트 해주는 과정입니다.
python manage.py runserver
## 아래와 같이 나오면 됩니다.
Django version 3.0.8, using settings 'api_server.settings'
Starting development server at http://127.0.0.1:8000/
Quit the server with CONTROL-C.여기까지 api 서버 프로젝트 할때 가장 기본적인 세팅이었습니다.
다음 글부터 회원관련 api 기능 개발에 대해 작성하겠습니다.
