📘

DJANGO for APIs - William S. Vincent

가. Test

1) Model 생성

라. User Authentication

1) Token 적용

2) DRF built-in 토큰 설정 특징

3) JWT 사용 권장

마. Viewsets & Routers

바. Schemas & Documentation

1) Schemas package

2) Documentation package

Reference

가. Test

1) Model 생성

•

Post 모델 생성

•

코드 참고

2) Test 작성

•

Post Model 대상 Unit 테스트 작성

•

코드 참고

나. Build Up DRF

1) DRF 설치

•

가상환경 내 DRF 설치 명령

•

pip install djangorestframework~=3.11.0

2) urls.py

•

기능: HTTP 요청 경로 설정 

•

코드 참고

3) serializers.py

•

기능: Model의 데이터를 JSON 형태로 직렬화

•

코드 참고

4) views.py

•

기능: 각각의 API end-point에 대해 비지니스 로직 적용

•

코드 참고

다. Permissions

1) View Level

•

기능: API 각각에 대한 permission 설정

•

코드 참고

2) Project Level

•

기능: 모든 API에 대한 default permission 설정

•

코드 참고

3) Custom

•

기능: 특정 API의 business logic에 따라 permission 설정

•

예시 코드의 경우 Post 작성자와 서비스 로그인 유저가 동일한 경우에만 Post 자원에 대해 갱신 가능

→ 단, Post 작성자와 서비스 로그인 유저가 다를 경우 Post 자원에 대한 조회 가능

•

코드 참고(설정)

•

코드 참고(적용)

라. User Authentication

1) Token 적용

•

코드 참고(설정)

•

코드 참고(적용)

2) DRF built-in 토큰 설정 특징

•

토큰 만료기간 미설정

→ 보안 상 취약하므로 토큰 만료기간에 대한 추가작업 필요

•

사용 환경에 관계 없이 하나의 사용자에게 하나의 토큰 발행

→ web 환경의 토큰 내 사용자 정보를 갱신하면 mobile 환경의 토큰 내 사용자 정보와 달라지므로 해당 정보의 유지와 갱신 이슈 발생

3) JWT 사용 권장

•

DRF built-in 토큰 설정 보완

→ 토큰 만료기간 설정 가능

→ 암호화하여 HTTP 전송 간 보안성 향상

→ 토큰의 유일성을 보장하는 발행 방식

마. Viewsets & Routers

1) Viewsets

•

복수의 연관된 view에 대해 하나의 클래스로 추상화

→ CRUD 기능을 구현하는 복수의 view를 하나의 클래스로 병합

2) Routers

•

Viewsets으로 정의된 클래스에 대해 HTTP Request Convention에 따라 Request URL 자동 매칭

•

(원인미상) users의 router.register 코드와 posts의 동일 코드의 위치와 바뀌면 '~/users' GET 요청에 대해 404 에러 발생

3) Post 적용

•

코드 참고

4) User 적용

•

코드 참고

바. Schemas & Documentation

1) Schemas package

•

Schema: machine-readable한 Document로 모든 API endpoint에 대한 outline 제공

•

사전 준비: pyyaml, uritemplate package 설치 필요

•

코드 참고

2) Documentation package

•

Document: Schema를 기반으로 human-readable한 Document로 바꾼 것

•

배포 시 주의사항

→ static file을 cloud storage에 올려두고 접근할 수 있도록 작업 필요

→ Django의 경우 아래와 같이배포환경설정에 정의된 storage 계정으로 static file을 업로드 필요

ex) python manage.py collectstatic --settings=backend.settings.prod

•

사전 준비

→ uritemplate, drf_yasg pakcage 설치 필요

→ INSTALLED_APPS 에 drf_yasg 추가 필요

•

코드 참고

Reference

•

Blog API Cloning, DJANGO for APIs(William S. Vincent)

•

참고 코드 전체, https://github.com/MJbae/drf-practice/