🔥TIL#4. 요청(Get, Post)처리를 위한 urls, models, views 정리 및 Test를 위한 Tool 안내

What you will learn?

1. project urls.py, app urls.py 에 대한 이해와 설정 방법
2. app views.py를 통해 request 에 대한 처리 및 response 방법
3. app models.py 에서 일부 Tip
4. Test tool 안내

1. project urls.py, app urls.py 에 대한 이해와 설정 방법

Django의 project 폴더에 있는 urls.py는 url Dispatcher의 역할을 한다. 우리가 Web Service에 요청을 한다는 것은 주로 url을 입력하여 정보를 Get 하거나 url과 함께 조건을 입력하여 Post 하는 것으로 볼 수 있다.(다른 Http 요청방식도 있으나 주로 Get, Post를 많이 사용)
Django는 사용자의 요청인 url정보를 분석, 어떤 App에 대한 요청인지를 판단 후 해당 App이 처리하도록 전달한다. 그러면 해당 App은 자체 urls.py를 확인, 추가 url 경로에 대한 url Dispatcher를 다시 한번 수행하여 최종 url에 매칭되는 View에게 처리를 넘긴다.

현재 작업중인 'starbucks' project와 'services' app을 예시로 설명하자면

위는 starbucks project의 urls.py 화면으로 urlpatterns 변수에 'services' 란 경로를 추가하고 이를 services의 urls.py에 연결하였다. 외부에서 localhost:8000/services 라는 요청이 들어오면 Django는 services App의 urls 로 Dispatcher 역할을 넘긴다.

App의 urls.py는 이후 url 정보에 따라 처리를 담당할 view를 지정한다. 위는 path함수내에 이름지정시 빈칸을 유지함으로서 'localhost:8000/services/'에 대한 처리를 CategoryView에게 위임함을 의미한다. 만약 이름을 부여한다면 'localhost:8000/services/부여한이름' 의 url에 대해서 CategoryView에 위임한다.

참고) view 뒤에 as_view() 가 사용되는데 이는 View 클래스에서 기본으로 제공되는 get, post 함수를 사용한다는 의미이다. 만약 사용자가 GET 에 대한 요청을 하면 CategoryView는 get()이 호출되고 POST 요청을 하면 post()가 호출 된다.

2. app views.py를 통해 request 에 대한 처리 및 response 방법

이제 url에 대해 view에서 어떻게 처리하는지를 살펴보자. url에 대한 처리를 view가 담당한다고 이야기 했듯이 위의 CategoryView라는 class가 views.py에 정의되어 있어야 한다. 아래 화면을 보자

'services' App의 views.py에 CategoryView class를 정의한 화면이다.
'as_view()'와 관련하여 앞서 설명했듯이 get, post 함수는 사용자의 요청 method타입에 따라 호출되며 호출시 실행될 로직을 정의해주면 된다. 여기선 get() 호출시 Categories table의 row별 id 및 name 정보를 dictionary로 묶어 json 타입으로 응답해주는 과정이다.
post()시에는 request와 함께 온 조건정보(request.body)를 python 형식으로 load, 이를 Menu table에 신규 row로 추가하고 Json응답을 보낸다.

3. app models.py 에서 일부 Tip

models.py에서 class 생성을 통해 만들 table을 설계하는 것은 이전 페이지에서 확인했다. 그런데 models.py에 정의한 class가 database로 migrate시 database 상에서의 table 명이 class 명과 다르다. 아래 예시를 보자.
아래 화면은 'services' app의 models.py에 정의된 class 정보이다.

다음 화면은 실제 database 상에서의 table 목록이다.

보는 바와 같이 Table 앞에 app이름(services + '-')이 자동으로 붙어서 생성되어 있는 것을 확인 할 수 있다. 이는 Django가 자동으로 부여하는 기능으로 이 기능을 무시하고 싶으면 아래 과정화면처럼 추가 로직을 넣으면 된다.

class에 내부class로 'Meta'가 정의, db_table이란 속성에 'menus'란 값을 입력하고 있다.
이 로직은 migrate시 Menu class를 'menus'란 table로 생성하겠다고 Django에 알리는 것이 된다.

4. Test tool 안내

Server의 처리로직을 테스트하려면 requester가 필요하다. web browser도 있으나 Terminal 에서 테스트 할 수 있도록 'httpie' 프로그램을 설치한다.

sudo apt-get install httpie

설치여부를 확인하려면 'http' 를 실행해보자.

jin@jin-Lenovo-IdeaPad-S340-15API:~/westagram$ http
usage: http [--json] [--form] [--pretty {all,colors,format,none}]
            [--style STYLE] [--print WHAT] [--headers] [--body] [--verbose]
            [--all] [--history-print WHAT] [--stream] [--output FILE]
            [--download] [--continue]
            [--session SESSION_NAME_OR_PATH | --session-read-only SESSION_NAME_OR_PATH]
            [--auth USER[:PASS]] [--auth-type {basic,digest}]
            [--proxy PROTOCOL:PROXY_URL] [--follow]
            [--max-redirects MAX_REDIRECTS] [--timeout SECONDS]
            [--check-status] [--verify VERIFY]
            ....

사용법은 아래와 같다 (starbucks project 기준)

http GET localhost:8000/services
http POST localhost:8000/services name="new value"