REST API 장고로 구현하기 - 2 (연습 프로젝트 준비)

REST API 를 장고를 이용해 구현하는 것이 이번 프로젝트의 목표다.

 

장고 개발을 위한 가상환경 설정 방법 및 장고 웹 어플리케이션의 동작 방법에 대해 이미 간단히 알고 있다고 가정하고 글을 쓰겠다.

잘 모르겠다면 온라인 무료 강의 및 공식문서 튜토리얼을 통해 익히고 오는 것을 추천한다.

 

(나는 1. Do it! 점프 투 장고, 2. 유튜브 생활코딩 장고 강의, 3. 공식문서 튜토리얼을 진행해봤다.  

난이도는 1> 3 >>>>> 2 이지만 2번은 정말 간단하게만 짚고 넘어가므로 2번으로 감을 잡고 1,3을 진행해보는 것을 추천한다.)

 

 

장고에서 REST API 개발을 할 때 유용한 REST framework 가 있다.

django REST framework 인데, 본 프로젝트 시작 전 아주 간단한 연습 프로젝트를 해보려고 한다.

pip install djangorestframework
pip install markdown
pip install django-filter

터미널을 열고 본인의 장고 프로젝트를 진행할 가상환경에 접속한 뒤 위의 명령어를 입력해 다운로드하자.

 

python manage.py startproject "projectName"
python manage.py startapp "appName"

그 이후 장고 위의 명령어를 이용해 프로젝트와 앱을 생성한후 몇개의 파일을 수정해야한다.

 

우선 메인 프로젝트 파일의 settings.py 로 이동해 앱 이름과 프레임워크 이름을 추가해줘야한다.

아무생각 없이 연습용 프로젝트 이름을 restApi, 앱 이름을 그냥 api 라고 지었는데 좋지 않은 이름이다.

 

settings.py 의 INSTALLED_APPS 로 가서 'rest_framework', 와 앱 이름을 추가하면 된다.

그리고 나서 settings.py의 맨 아래로 내려가 다음과 같은 코드를 추가해준다.

REST_FRAMEWORK = {
    # Use Django's standard `django.contrib.auth` permissions,
    # or allow read-only access for unauthenticated users.
    'DEFAULT_PERMISSION_CLASSES': [
        'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly'
    ]
}

 

그 후 settings.py와 같은 프로젝트 폴더에 위치한(앱 파일이 아니다) urls.py에 들어가 빨간 밑줄 그은 코드를 추가해준다.

이렇게 하면 기본 세팅은 끝난다.

 

여기서 원한다면 데이터베이스를 연결하고, 깃허브 레포지토리에 연결하는 등 과정이 있지만

선택사항이고 간단한 연습 프로젝트이므로 여기선 생략하도록 하겠다.

 

 

또 API 서버 테스트를 위해 서버로 데이터를 전송해주는 프론트엔드의 역할을 대신해주는 클라이언트를 사용해보기로 했다.

"isomnia" 인데 구글에 검색하면 무료로 다운받을 수 있다.

 

마무리하기 전 migration을 진행해 기본 데이터베이스를 만들고 runserver 명령어까지 잘 실행되는지 확인하자.

 

연습 프로젝트는 https://grape-blog.tistory.com/13?category=473970를  참고했다.