프로그래밍/[ Django ]

Django REST API 서버 만들기

망나 2022. 4. 20. 23:10

Restful API 란?

  • Representational State Transfer의 약자 Rest로 소프트웨어 프로그램 아키텍처의 한 형식을 의미합니다.
  • 자원을 이름으로 구분하여 자원의 상태(정보)를 주고 받는 모든 것을 의미합니다.
  • HTTP 프로토콜을 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키텍처 입니다.

 

REST 구성

1. 자원 (Resource) - URL

- HTTP url을 활용한 고유한 ID로 구분합니다.

 

2. 행위 (Verb) - HTTP Method

- HTTP 프로토콜의 GET, POST, PUT, DELETE

 

3. 표현 (Representations)

- Client가 자원의 정보에 대한 조작을 요청하면 Server는 이에 대응하는 Representation을 보냅니다.

- REST에서 자원은 JSON, XML, TEXT, RSS등 여러 형태의 표현으로 나타내며 현재 대부분 JSON을 사용합니다.

 

 

 

쉽게 말하자면, 다양한 플랫폼에 맞추어 범용적으로 사용성을 보장하는 HTTP와 URI 기반으로 자원에 접근할 수 있도록 하는 어플리케이션 개발 인터페이스라고 할 수 있습니다. 즉, HTTP Method와 URI 만으로 인터넷 자료를 CRUD 할 수 있습니다.

 

그렇다면 이제 Django REST Framwork (DRF)에 대해서 알아보도록 하겠습니다.

 

 

Django REST Framwork (DRF)

DRF란 Django 안에서 RESTful API 서버를 쉽게 구축할 수 있도록 도와주는 오픈소스 라이브러리 (프레임워크) 입니다.

 

DRF를 사용하는 이유

  • 웹 브라우저 API는 범용성이 크고 개발을 쉽게 만들어 줍니다.
  • ORM & non-ORM에 대해 모두 Serialization 기능을 제공해줍니다. (DB data -> Json)
  • 문서화와 커뮤니티 지원이 잘 되어 있습니다.
  • 프론트엔드와 백엔드 분리가 가능해집니다.

 

DRF 튜토리얼

(출처 공식 문서:https://www.django-rest-framework.org/tutorial/quickstart/)


admin user로 하여금 users와 groups을 확인하고 수정할 수 있는 간단한 API를 만들어 보겠습니다.

 

1) 프로젝트 셋업

새로운 장고 프로젝트 tutorial을 생성하고 quickstart라는 app을 만들어 보겠습니다.

 

1.1) 프로젝트 디렉토리 생성

 

프로젝트 디렉토리 생성

 

 

1.2) django, djangorestframework 설치

 

 

 

1.3) tutorial 프로젝트 생성

 

이전에 tutorial 디렉토리를 이미 생성했기 때문에 마지막에 .을 꼭 붙여야한다.

 

 

1.4) quickstart 앱 생성

 

앱까지 생성하고 나면 위와 같은 프로젝트 모습이 될 것 입니다.

 

 

1.5)  관리자 유저 생성

 

저는 비밀번호를 대충 지었더니 위와 같은 경고문구가 발생했네요.. ㅎㅎ

 

 

2) Serializers

처음으로 데이터 표현(representations)에 사용될 모듈 tutorial/quickstart/serializers.py을 정의해 보겠습니다.

 

HyperlinkedModelSerializer를 활용하여 hyperlinked relations을 사용합니다.

 

 

3) View

tutorial/quickstart/views.py에 views를 작성해 보겠습니다.

 

잘 정리된 ViewSets을 사용하여 위와 같이 깔끔하고 쉬운 코드 작성이 가능합니다.

 

4) URLs

다음으로 ututorial/urls.py에 아래와 같이 API URL들을 작성합니다.

 

튜토리얼에서는 views가 아닌 viewsets을 사용하고 있기 때문에 위에 보이는 것과 같이 쉽게 router class와 함께 API URL을 등록할 수 있습니다.

만약 class-based views를 사용한다면, API URLS를 좀 더 원하는 형태로 변형하여 사용할 수 있습니다.

 

 

 

5) Settings

tutorial/settings.py에 'rest_framework'를 추가해 줍니다.

 

 

 

 

6) Testing API

python manage.py runserver 커맨드를 통해서 서버를 실행시킬 수 있습니다.

 

 

이제 위에 서버 url 정보를 활용해서 user list API를 확인해보도록 하겠습니다.

 

예상과 다르게 인증 권한이 제공되지 않았다는 오류 메시지가 확인됩니다...

이는 우리가 아까 view 코드에 아래 코드를 추가했기 때문입니다. 

(인가, 인증 관련 기능은 추후에 더 자세히 포스팅 하도록 하겠습니다.)

permission_classes = [permissions.IsAuthenticated]

따라서, 오른쪽 위에 보이는 Log in 버튼을 클릭하고 이전에 생성했던 관리자 아이디로 로그인을 하면 페이지 권한을 얻을 수 있습니다!

 

자, 이제 아래 페이지 처럼 사용자 친화적(?)인 화면을 통해서 GET, POST 기능을 사용할 수 있습니다.

 

 

이번 포스트에서는 Djjango REST framework 공식 문서에서 제공하는 튜토리얼을 따라해보며 아주 간단한 API 서버를 구성해봤습니다.

 

다음 포스터부터는 조금 더 자세한 내용을 하나씩 다뤄보도록 하겠습니다.

 

 

1