Django REST framework 1

뚝딱뚝딱·2023년 10월 18일

django

Django

목록 보기

12/13

REST API

API

Application Programming Interface

애플리케이션과 프로그래밍으로 소통하는 방법
클라이언트-서버처럼 서로 다른 프로그램에서 요청과 응답을 받을 수 있도록 만든 체계

Web API

웹 서버 또는 웹 브라우저를 위한 API
현대 웹 개발은 하나부터 열까지 직접 개발하기보다 여러 Open API들을 활용하는 추세

REST(Representational State Transfer)

여기서 상태는 데이터
API Server를 개발하기 위한 일종의 소프트웨어 설계 방법론
"약속(규칙X)"

RESTful API

REST 원리를 따르는 시스템을 RESTful하다고 부름
'자원(데이터)을 정의'하고 '자원에 대한 주소를 지정'하는 전반적인 방법을 서술

각각 API구조를 작성하는 모습이 너무 다르니 약속을 만들어서 다같이 통일해서 쓰자!

REST API

REST라는 설계 디자인 약속을 지켜 구현한 API

REST에서 자원을 정의하고 주소를 지정하는 방법

1. 자원의 식별

2. 자원의 행위

HTTP Methods (GET게시물 달라 / POST정보줄테니 만들어달라)

3. 자원의 표현

JSON 데이터
궁극적으로 표현되는 데이터 결과물

1. 자원의 식별

URI

Uniform Resource Identifier (통합 자원 식별자)

인터넷에서 리소스(자원)를 식별하는 문자열
가장 일반적인 URI는 웹 주소로 알려진 URL

URL

Uniform Resource Locator (통합 자원 위치)

웹에서 주어진 리소스의 주소 -> 네트워크 상에 리소스가 어디 있는지를 알려주기 위한 약속

Schema(or Protocol)

브라우저가 리소스를 요청하는 데 사용해야 하는 규약
URL의 첫 부분은 브라우저가 어떤 규약을 사용하는지를 나타냄
기본적으로 웹은 THHP(S)를 요구하며 메일을 열기 위한 mailto:,
파일을 전송하기 위한 ftp: 등 다른 프로토콜도 존재

Domain Name

요청 중인 웹 서버를 나타냄
어떤 웹 서버가 요구되는 지를 가리키며 직접 IP 주소를 사용하는 것도 가능하지만, 사람이 외우기 어렵기 때문에(사용자 친화적이지 않음) 주로 Domain Name으로 사용
예를 들어 도메인 google.com 의 IP주소는 142.251.42.142
도메인 이름을 돈주고 산다

Port

웹 서버의 리소스에 접근하는데 사용되는 기술적인 문(Gate)
HTTP 프로토콜의 표준 포트
- HTTP - 80
- HTTPS - 443
표준 포트만 생략 가능

Path

웹 서버의 리소스 경로
초기에는 실제 파일이 위치한 물리적 위치를 나타냈지만, 오늘날은 실제 위치가 아닌 추상화된 형태의 구조를 표현
예를 들어 /articles/create/가 실제 articles 폴더 안에 create 폴더안을 나타내는 것은 아님

Parameters

웹 서버에 제공하는 추가적인 데이터
'&'기호로 구분되는 key-value 쌍 목록
서버는 리소스를 응답하기 전에 이러한 파라미터를 사용하여 추가 작업을 수행할 수 있음
GET 배울때 (검색 할때) 배웠음 (검색 데이터가 파라미터로 넘어갔다.)

Anchor

일종의 '북마크'를 나타내며 브라우저에 해당 지점에 있는 콘텐츠를 표시
fragment identifier(부분 식별자)라고 부르는 # 이후 부분은 서버에 전송되지 않음

https://docs.djangoproject.com/en/4.2/intro/install/#quick-install-guide

위 요청에서 #quick-install-guide는 서버에 전달되지 않고 브라우저에게 해당 지점으로 이동할 수 있도록 함

2. 자원의 행위

HTTP Request Methods

리소스에 대한 행위(수행하고자 하는 동작)을 정의
-> HTTP verbs 라고도 함

HTTP response status codes

특정 HTTP 요청이 성공적으로 완료되었는지 여부를 나타냄

5개의 응답 그룹

Informational responsese(100-199)

Successful responses(200-299)

Redirection messages(300-399)

Client error responses(400-499)

Server error responses(500-599)

3. 자원의 표현

그동안 서버가 응답(자원을 표현)했던 것 = 지금까지 Django 서버는 사용자에게 페이지(html)만 응답하고 있었음

하지만 서버가 응답할 수 있는 페이지 뿐만 아니라 다양한 데이터 타입을 응답할 수 있음
REST API는 이 중에서도 JSON 타입으로 응답하는 것을 권장

응답 데이터 타입의 변화

페이지(html)만을 응답하는 서버
이제는 JSON 데이터를 응답하는 REST API 서버로의 변환
Django는 더 이상 Template 부분에 대한 역할을 담당하지 않게 되며, Front-end 와 Back-end가 구분되어 구성 됨
이제부터 Django를 사용해 RESTful API 서버를 구축할 것

python으로 json 응답받기

DRF(Django REST framework)

Django에서 Restful API 서버를 쉽게 구축할 수 있도록 도와주는 오픈소스 라이브러리

Serialization " 직렬화 "

여러 시스템에서 활용하기 위해 데이터 구조나 객체 상태를 나중에 재구성할 수 있는 포맷(리스트/ 딕셔너리 등)으로 변환하는 과정

어떠한 언어나 환경에서도 나중에 다시 쉽게 사용할 수 있는 포맷으로 변환하는 과정

DRF with Single Model

Postman

API를 구축하고 사용하기 위한 플랫폼

API를 빠르게 만들 수 있는 여러 도구 및 기능을 제공

화면구성

URL과 HTTP requests methods 설계

GET

GET-List

게시글 데이터 목록 조회하기

게시글 데이터 목록을 제공하는 ArticleListSerializer 정의
serializers.py의 위치나 파일명은 자유롭게 작성 가능

ModelSerializer

Django 모델과 연결된 Serializer 클래스

url 및 view 함수 작성

이전 view 함수와의 비교

똑같은 데이터를 HTML에 출력되도록 페이지와 함께 응답했던 과거의 view 함수, JSON 데이터로 serialization하여 페이지 없이 응답하는 현재의 view 함수

api_view decorator

DRF view 함수에서는 필수로 작성되며 view 함수를 실행하기 전 HTTP 메서드를 확인

기본적으로 GET 메서드만 허용되며 다른 메서드 요청에 대해서는 405 Method Not Allowed로 응답

DRF view 함수가 응답해야 하는 HTTP 메서드 목록을 작성