{
    "componentChunkName": "component---src-templates-blog-post-js",
    "path": "/django-rest-framework/django-start-with-drf/",
    "result": {"data":{"site":{"siteMetadata":{"title":"Today I Learned"}},"markdownRemark":{"id":"38d9b1a9-26ba-536e-bf45-12021e4e2a87","excerpt":"0. 서론 장고 프로젝트를 생성하는것부터 간단한 API 를 만드는 과정을 정리한다.…","html":"<h2>0. 서론</h2>\n<p>장고 프로젝트를 생성하는것부터 간단한 API 를 만드는 과정을 정리한다.</p>\n<h2>1. 장고 프로젝트 생성</h2>\n<p>프로젝트의 <code class=\"language-text\">root</code> 로 사용될 디렉토리를 먼저 생성하고 그 안에서 프로젝트를 생성 하는 명령어를 실행한다.<br>\n나는 프로젝트 이름을 <code class=\"language-text\">config</code> 로 정했다.</p>\n<div class=\"gatsby-highlight\" data-language=\"shell\"><pre class=\"language-shell\"><code class=\"language-shell\">$ <span class=\"token function\">mkdir</span> ingredient-manage\r\n$ <span class=\"token builtin class-name\">cd</span> ingredient-manage \r\n$ django-admin startproject config <span class=\"token builtin class-name\">.</span></code></pre></div>\n<p>이렇게 하고 나면 다음과 같은 구조의 디렉토리와 파일을 볼 수 있는데, 모든 프로젝트 관련 파일은 <code class=\"language-text\">ingredient-manage</code> 디렉토리에 위치한다. 이후 여기에서 <code class=\"language-text\">app</code> 을 추가하는 방식으로 개발을 진행할것이다.</p>\n<div class=\"gatsby-highlight\" data-language=\"text\"><pre class=\"language-text\"><code class=\"language-text\">ingredient-manage\r\n├── config\r\n    ├── __init__.py\r\n    ├── asgi.py\r\n    ├── settings.py\r\n    ├── urls.py\r\n    ├── wsgi.py\r\n├── manage.py</code></pre></div>\n<h2>2. IDE 설정</h2>\n<p>각 IDE 에 맞게 파이썬 인터프리터 및 테스트 환경을 설정해준다.</p>\n<p><a href=\"/TIL/IDE/the-pycharm-i-know/\">Pycharm 설정 방법</a></p>\n<h2>3. django-rest-framework 설치</h2>\n<p>drf 를 사용하기 위해 필요한 패키지를 설치한다.</p>\n<div class=\"gatsby-highlight\" data-language=\"shell\"><pre class=\"language-shell\"><code class=\"language-shell\">$ <span class=\"token builtin class-name\">cd</span> ingredient-manage\r\n$ pip <span class=\"token function\">install</span> djangorestframework\r\n$ pip <span class=\"token function\">install</span> django-filter </code></pre></div>\n<h2>4. app 생성하기</h2>\n<p>다음으로 app 을 하나 생성한다.<br>\n각 기능별로 app 을 분리하여 재사용 할 수도 있지만 지금 단계에서는 하나의 app 에 모든 기능을 만들 예정이다.</p>\n<div class=\"gatsby-highlight\" data-language=\"shell\"><pre class=\"language-shell\"><code class=\"language-shell\">$ django-admin startapp management</code></pre></div>\n<h2>5. settings.py 파일 설정하기</h2>\n<h3>5.1 INSTALLED_APPS</h3>\n<p>drf 와 방금 생성한 app 을 사용하기 위해 <code class=\"language-text\">INSTALLED_APPS</code> 에 drf 와 새로 생성한 app 을 추가했다.</p>\n<div class=\"gatsby-highlight\" data-language=\"python\"><pre class=\"language-python\"><code class=\"language-python\">INSTALLED_APPS <span class=\"token operator\">=</span> <span class=\"token punctuation\">[</span>\r\n<span class=\"token punctuation\">.</span><span class=\"token punctuation\">.</span><span class=\"token punctuation\">.</span>\r\n    <span class=\"token string\">'rest_framework'</span><span class=\"token punctuation\">,</span>\r\n    <span class=\"token string\">'django_filters'</span><span class=\"token punctuation\">,</span>\r\n    <span class=\"token string\">'management.apps.ManagementConfig'</span></code></pre></div>\n<h3>5.2 Internationalization</h3>\n<p>i18n 설정을 다음과 같이변경한다. 언어 코드와 타임존을 변경했고, DB 에 한국 시간(<code class=\"language-text\">KST</code>)을 저장하기 위해 <code class=\"language-text\">USE_TZ</code> 를 <code class=\"language-text\">False</code> 로 변경했다. 만약 <code class=\"language-text\">True</code> 상태라면 <code class=\"language-text\">UTC</code> 시간이 저장된다.</p>\n<div class=\"gatsby-highlight\" data-language=\"python\"><pre class=\"language-python\"><code class=\"language-python\">LANGUAGE_CODE <span class=\"token operator\">=</span> <span class=\"token string\">'ko-kr'</span>\r\n\r\nTIME_ZONE <span class=\"token operator\">=</span> <span class=\"token string\">'Asia/Seoul'</span>\r\n\r\nUSE_I18N <span class=\"token operator\">=</span> <span class=\"token boolean\">True</span>\r\n\r\nUSE_L10N <span class=\"token operator\">=</span> <span class=\"token boolean\">True</span>\r\n\r\nUSE_TZ <span class=\"token operator\">=</span> <span class=\"token boolean\">False</span></code></pre></div>\n<h3>5.3 secret 파일</h3>\n<p>나는 이번 장고 프로젝트를 github 의 public repository 에 업로드 할 예정인데, 이렇게 하면 패스워드나 키가 공개되어 문제가 발생할 수 있다.<br>\n그래서 이런 중요한 정보는 별도로 다른 파일에 보관하고 <code class=\"language-text\">settings.py</code> 에서 그 파일을 불러오도록 할 것이다.</p>\n<p>먼저 <code class=\"language-text\">django-secret.json</code> 이라는 파일을 프로젝트 루트 디렉토리(<code class=\"language-text\">ingredient-manage</code>)에 생성한다. 그 다음 공개하지 않고 싶은 패스워드나 키를 추가한다.</p>\n<div class=\"gatsby-highlight\" data-language=\"json\"><pre class=\"language-json\"><code class=\"language-json\"><span class=\"token punctuation\">{</span>\r\n  <span class=\"token property\">\"DJANGO_SECRET_KEY\"</span><span class=\"token operator\">:</span> <span class=\"token string\">\"\"</span><span class=\"token punctuation\">,</span>\r\n  <span class=\"token property\">\"DB_DEFAULT_ENGINE\"</span><span class=\"token operator\">:</span> <span class=\"token string\">\"\"</span><span class=\"token punctuation\">,</span>\r\n  <span class=\"token property\">\"DB_DEFAULT_NAME\"</span><span class=\"token operator\">:</span> <span class=\"token string\">\"\"</span><span class=\"token punctuation\">,</span>\r\n  <span class=\"token property\">\"DB_DEFAULT_USER\"</span><span class=\"token operator\">:</span> <span class=\"token string\">\"\"</span><span class=\"token punctuation\">,</span>\r\n  <span class=\"token property\">\"DB_DEFAULT_PASSWORD\"</span><span class=\"token operator\">:</span> <span class=\"token string\">\"\"</span><span class=\"token punctuation\">,</span>\r\n  <span class=\"token property\">\"DB_DEFAULT_HOST\"</span><span class=\"token operator\">:</span> <span class=\"token string\">\"\"</span><span class=\"token punctuation\">,</span>\r\n  <span class=\"token property\">\"DB_DEFAULT_PORT\"</span><span class=\"token operator\">:</span> <span class=\"token string\">\"\"</span><span class=\"token punctuation\">,</span>\r\n  <span class=\"token property\">\"PROD_ALLOWED_HOSTS\"</span><span class=\"token operator\">:</span> <span class=\"token punctuation\">[</span><span class=\"token punctuation\">]</span>\r\n<span class=\"token punctuation\">}</span></code></pre></div>\n<p>그다음으론 이 파일을 읽은 뒤 적절한 위치에 적절히 호출하면 된다.<br>\n나는 <code class=\"language-text\">settings.py</code> 파일의 <code class=\"language-text\">BASE_DIR</code> 옵션 바로 밑에서 <code class=\"language-text\">django-secret.json</code> 파일을 불러왔다.</p>\n<div class=\"gatsby-highlight\" data-language=\"python\"><pre class=\"language-python\"><code class=\"language-python\"><span class=\"token keyword\">import</span> json\r\n<span class=\"token keyword\">from</span> pathlib <span class=\"token keyword\">import</span> Path\r\n\r\n<span class=\"token keyword\">from</span> django<span class=\"token punctuation\">.</span>core<span class=\"token punctuation\">.</span>exceptions <span class=\"token keyword\">import</span> ImproperlyConfigured\r\n\r\n<span class=\"token punctuation\">.</span><span class=\"token punctuation\">.</span><span class=\"token punctuation\">.</span>\r\n\r\nBASE_DIR <span class=\"token operator\">=</span> Path<span class=\"token punctuation\">(</span>__file__<span class=\"token punctuation\">)</span><span class=\"token punctuation\">.</span>resolve<span class=\"token punctuation\">(</span><span class=\"token punctuation\">)</span><span class=\"token punctuation\">.</span>parent<span class=\"token punctuation\">.</span>parent\r\n\r\n<span class=\"token comment\"># get secret file</span>\r\n<span class=\"token keyword\">with</span> <span class=\"token builtin\">open</span><span class=\"token punctuation\">(</span><span class=\"token string\">'./django-secret.json'</span><span class=\"token punctuation\">)</span> <span class=\"token keyword\">as</span> f<span class=\"token punctuation\">:</span>\r\n    django_secret <span class=\"token operator\">=</span> json<span class=\"token punctuation\">.</span>loads<span class=\"token punctuation\">(</span>f<span class=\"token punctuation\">.</span>read<span class=\"token punctuation\">(</span><span class=\"token punctuation\">)</span><span class=\"token punctuation\">)</span>\r\n\r\n\r\n<span class=\"token keyword\">def</span> <span class=\"token function\">get_secret</span><span class=\"token punctuation\">(</span>setting<span class=\"token punctuation\">,</span> secrets<span class=\"token operator\">=</span>django_secret<span class=\"token punctuation\">)</span><span class=\"token punctuation\">:</span>\r\n    <span class=\"token keyword\">try</span><span class=\"token punctuation\">:</span>\r\n        <span class=\"token keyword\">return</span> secrets<span class=\"token punctuation\">[</span>setting<span class=\"token punctuation\">]</span>\r\n    <span class=\"token keyword\">except</span> KeyError<span class=\"token punctuation\">:</span>\r\n        error_msg <span class=\"token operator\">=</span> <span class=\"token string\">\"Set the {0} enviroment varialble\"</span><span class=\"token punctuation\">.</span><span class=\"token builtin\">format</span><span class=\"token punctuation\">(</span>setting<span class=\"token punctuation\">)</span>\r\n        <span class=\"token keyword\">raise</span> ImproperlyConfigured<span class=\"token punctuation\">(</span>error_msg<span class=\"token punctuation\">)</span>\r\n        \r\n<span class=\"token punctuation\">.</span><span class=\"token punctuation\">.</span><span class=\"token punctuation\">.</span></code></pre></div>\n<p>그리고 아래처럼 호출했다.</p>\n<div class=\"gatsby-highlight\" data-language=\"python\"><pre class=\"language-python\"><code class=\"language-python\"><span class=\"token punctuation\">.</span><span class=\"token punctuation\">.</span><span class=\"token punctuation\">.</span>\r\n\r\nSECRET_KEY <span class=\"token operator\">=</span> get_secret<span class=\"token punctuation\">(</span><span class=\"token string\">\"DJANGO_SECRET_KEY\"</span><span class=\"token punctuation\">)</span>\r\n\r\n<span class=\"token punctuation\">.</span><span class=\"token punctuation\">.</span><span class=\"token punctuation\">.</span></code></pre></div>\n<p><code class=\"language-text\">SECRET_KEY</code> 뿐 아니라 DB 정보도 같은 방식으로 호출하면 중요한 정보를 노출하지 않을 수 있다.</p>\n<h3>5.4 settings 분리하기</h3>\n<p>이제 <code class=\"language-text\">settings.py</code> 파일을 분리한다.  개발과 운영 환경을 다르게 유지하기 위한것인데, <code class=\"language-text\">DEBUG</code> 옵션 처럼 각 운영 환경에서 다른 값을 설정해야 하는 경우 필요한 작업이다.</p>\n<h4>5.4.1 python package 생성</h4>\n<p><span\n      class=\"gatsby-resp-image-wrapper\"\n      style=\"position: relative; display: block; margin-left: auto; margin-right: auto; max-width: 950px; \"\n    >\n      <a\n    class=\"gatsby-resp-image-link\"\n    href=\"/TIL/static/4b948afc15344ac8646347dd31d80d02/11b93/541-0-new-python-package.png\"\n    style=\"display: block\"\n    target=\"_blank\"\n    rel=\"noopener\"\n  >\n    <span\n    class=\"gatsby-resp-image-background-image\"\n    style=\"padding-bottom: 40.33613445378151%; position: relative; bottom: 0; left: 0; background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAICAYAAAD5nd/tAAAACXBIWXMAABYlAAAWJQFJUiTwAAAB0klEQVQoz0WPy04UQQBF5weUtW5MjGyIIDAzPdOP6qrqd1c/pnua7pkJxhhMwISA+AWueWjiyoSfPQYIuri5u3PPHe0qg15+JO42SFNhRRkiL9i1PT64/r/sOR57nub9zOdgPGX/cMLOzg6H4wmO5zOxZswdj9Gbsc+eTBlXJ7xubnm3uuOluWaruGWruHlqc80L85NX8RXzpEKFCZYjmLuCqe0ytmwsx+NgYjGSSiOVQoQ50eqSaDjHMidM8xOm5imW+UIwXOGZDe2qpy4ziiIjTSPiWKOkw6LKUNJl5Pga21c4wmexqCirAq0lWvso7SOVwBMuJg9xs570/A/m8p784p7k7DezT794296wfXTHdv3jAahwpcaRmqxc0G+OyasGU7eYuiEpKjwdEaUZdlgRrL+jhm/o1RWqv8AqT9nPzzgovrKffH4CiiAiqQqCOCHJC4IkRegQW0ieB+PU4EYh8dDQtTWLpqIsDVkWI4SD8GwcZ87IERIRxqRNiQpCFl1Pv97QDatH6APQDyK6foUXRhTrga5fsxzW6CTD0yGuDHBkgO3r/4ahyVBhxHJYUTVL6rZ7tH2wlGFM2XZEgea4Lai7geXRQF7Vj2PPL2au4C+wyiQJQ345ZAAAAABJRU5ErkJggg=='); background-size: cover; display: block;\"\n  ></span>\n  <img\n        class=\"gatsby-resp-image-image\"\n        alt=\"new-python-package\"\n        title=\"new-python-package\"\n        src=\"/TIL/static/4b948afc15344ac8646347dd31d80d02/906b5/541-0-new-python-package.png\"\n        srcset=\"/TIL/static/4b948afc15344ac8646347dd31d80d02/5ea4d/541-0-new-python-package.png 238w,\n/TIL/static/4b948afc15344ac8646347dd31d80d02/466da/541-0-new-python-package.png 475w,\n/TIL/static/4b948afc15344ac8646347dd31d80d02/906b5/541-0-new-python-package.png 950w,\n/TIL/static/4b948afc15344ac8646347dd31d80d02/11b93/541-0-new-python-package.png 1124w\"\n        sizes=\"(max-width: 950px) 100vw, 950px\"\n        style=\"width:100%;height:100%;margin:0;vertical-align:middle;position:absolute;top:0;left:0;\"\n        loading=\"lazy\"\n        decoding=\"async\"\n      />\n  </a>\n    </span></p>\n<p><code class=\"language-text\">config</code> 디렉토리에 <code class=\"language-text\">settings</code> 라는 이름의 <code class=\"language-text\">Python Package</code> 를 생성한 뒤 그 내부에 <code class=\"language-text\">base.py</code>, <code class=\"language-text\">local.py</code>, <code class=\"language-text\">prod.py</code> 파일 세개를 추가한다.<br>\n이때 파일 구조는 아래 사진과 같다.</p>\n<p><span\n      class=\"gatsby-resp-image-wrapper\"\n      style=\"position: relative; display: block; margin-left: auto; margin-right: auto; max-width: 494px; \"\n    >\n      <a\n    class=\"gatsby-resp-image-link\"\n    href=\"/TIL/static/d5c149e18c7b484c6709dafc3560a4f4/d72d4/541-1-directory-tree.png\"\n    style=\"display: block\"\n    target=\"_blank\"\n    rel=\"noopener\"\n  >\n    <span\n    class=\"gatsby-resp-image-background-image\"\n    style=\"padding-bottom: 124.36974789915966%; position: relative; bottom: 0; left: 0; background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAZCAYAAAAxFw7TAAAACXBIWXMAABYlAAAWJQFJUiTwAAADRklEQVQ4y5VVSY/bNhjVvT0UObRBs/RQdEHbIAky40X7au2kKGqXvHQ6aRKgaP7/6QWknRknsCeZw7Mlknp63/sWKQ9eOniiJpgVa/xs5fjNLfCLTfBsxfFnUMrrn7RErv/qUHn/RI3x3XMbDy98/HDh4fE8wI+zAI/mAZRvXvj4fplB79/hj6iDP73FZbHFotxBra7wPJvwe9hCb64xL/9GvPsPfyUDvn3h4qme4eEixlM9xWM1wSM1gbIwLKiWi7lhg/ZbkHZEEGdIWYWYlnilGni11PFyoUlcqAYuVQML08ZMtyQuNevmWtEsG4btwnQ8xIQhKyvwpkOSU/CmhRdGsDxf7hu2I8/qtgPNcqCfgKKaDlTTljBdD2FGsX77P8qqRtuPaIcJ26t/4K0iiGgWurk/b90+t8f+XhE/4m3a4YD4X+oGsnZEWFBohgVWt1glmdxPSQHT9XH83DGUz8kEFqqBYjOCTwRBmCAhhbRgFaeouwFOEGJpWHcTfqJQM5BPE+pdi2Fco6xbsKoBYRyXqn5z7pRK5dRbFpoJ2jfgPUFGS+RFKcnCQ9jnyM4qlISbCfWmAOO1zHrBa+nfx1Dv5eF8qSEfhIc1aFFKMgHh4TnvzioUNaY7EeKGgw8pcsoR5wRZwT4hFGXyRcKlYcIKYvTv/4XrGYjTAmXTwvZXSAiVod9PoWHB9EK0Vx0II8hF+2VEJsWPErir6Kx3ZxRaUmH7ZgSvC3TjBmXdIGclLpYaZppxY83XZVko9CPw1zvwmqHuRtnPVdfLpNCyup9CQWj5EZrrESlJkOSFrD3KK4RpLrvli4THB2TIfoz23RaUZSh4IxWKLM9UXQ6Grwr5puUOCrvrCRnJQFglOySjDIbj3anspELV3HtYvW5AihhVN4JVe+8E4eeqTvayWLTcAI6/Qn/1Bs16B1Zy1P2Iqu3lPORth35awwvj23l4pqeV442IMDn6oyyXEOUi+jdKcwkxtsQstLwAuu3ePW3mmg7aDKiGLZpuQNOPEqKwu3GSauvD+rjZyk/Dqa5RbieMgawbQccehDJQXsuiFkkRneIEK0nwUdnZkI9nYNJwVGOEjDCQspKqBKkoavcwpU99Mo4JPwAuN4E789J9zwAAAABJRU5ErkJggg=='); background-size: cover; display: block;\"\n  ></span>\n  <img\n        class=\"gatsby-resp-image-image\"\n        alt=\"directory-tree\"\n        title=\"directory-tree\"\n        src=\"/TIL/static/d5c149e18c7b484c6709dafc3560a4f4/d72d4/541-1-directory-tree.png\"\n        srcset=\"/TIL/static/d5c149e18c7b484c6709dafc3560a4f4/5ea4d/541-1-directory-tree.png 238w,\n/TIL/static/d5c149e18c7b484c6709dafc3560a4f4/466da/541-1-directory-tree.png 475w,\n/TIL/static/d5c149e18c7b484c6709dafc3560a4f4/d72d4/541-1-directory-tree.png 494w\"\n        sizes=\"(max-width: 494px) 100vw, 494px\"\n        style=\"width:100%;height:100%;margin:0;vertical-align:middle;position:absolute;top:0;left:0;\"\n        loading=\"lazy\"\n        decoding=\"async\"\n      />\n  </a>\n    </span></p>\n<h4>5.4.2 base.py 설정</h4>\n<p>다음으로는 <code class=\"language-text\">settings.py</code> 파일의 내용을 모두 복사해 <code class=\"language-text\">base.py</code> 파일에 붙여넣은 뒤 삭제한다.</p>\n<p><span\n      class=\"gatsby-resp-image-wrapper\"\n      style=\"position: relative; display: block; margin-left: auto; margin-right: auto; max-width: 496px; \"\n    >\n      <a\n    class=\"gatsby-resp-image-link\"\n    href=\"/TIL/static/c2c8d1dde2a36c0f5f11e58d71d538bb/bb630/542-directory-tree.png\"\n    style=\"display: block\"\n    target=\"_blank\"\n    rel=\"noopener\"\n  >\n    <span\n    class=\"gatsby-resp-image-background-image\"\n    style=\"padding-bottom: 113.02521008403362%; position: relative; bottom: 0; left: 0; background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAXCAYAAAALHW+jAAAACXBIWXMAABYlAAAWJQFJUiTwAAADB0lEQVQ4y5WUSY/bRhCFhQA555DlbCAB7CA2HCPRSJS4iSIlcV+abFKURrPIkxg5+v8Dn9Eta6JJNDP2oYAmuvi6XlW9N/j2bcB34xTn+iMvwy2j5o63xQ0j+RcXzR2/pVf8suz5vbzlD/Eeo/vA6/SKb157/DCOdfxoxPxkJHw/ihi8GM742fAZLkuGUc1C7pjGNVYqMVPJu3nCGzdkuMgZLjLcTDJaFbwYurya+LyaHuLXacDLic/Aclxcb47jzpDba9rdLVmeU9UN/WaL4825MCaMpyYT02Y0NTFMC9t1MZ2TsF0U1mBiz5jYLoblYns+fpTQ7z8Q5SVV01LUDVklCMIYw3YxXY+pc/jn8O/DGKgLlaDCns1xgyV521PULVXTEyYZcr1hEcWMTJuxaWNYzgnowxgcD6cJf16MCNs1yVZoKqrKvKo1g6ZbE6YZ48+g/43B8XBaqWE6xLVAXpYkeUmUFURpTpTlLOMUZx48yD8LeBrG1CbpOrp9jaglbb899FM0jKbWA0ZfCGgR1pJqJ8lLQVFL0rLSlT4F9j/AY5KmLCViVxDGqaYdZ4UO45HePdnD0dggXW9o3vcUlaDu1lSy1cCnE/6iCtWerUSHF64oSl/3zV9FLKNEU34K7Aygg+0t6f+5JEp9grCgauQ9mFz3+sGvAHSxZgHl7RWiFQjZkZVC76ACUnS/cigOlreg2fckRURZt8R5oXt3lNyzlE8vD5QXNH9fk4mUQrSUjdRVKsk9B3YG0MXyAuSNqjAmySttDHFeatk9B3ZP+egchmljzgLE3ZqsWlG3G+q205NWcjtW+RR1XaF63fF85G5Pe7WnEgLRtHr/1GSFbGm6XpvCcTCPDWdw3L2p7bJMC+KyIUxzVkmq5aYoK0NQNjYLlliup/MfW5/7KSvRp6JFrC/pNlvqdk23udT7p85KKepbGcVmd60fOCfDwb/6tQgrSdZvSItSD0JNWOlXgQZhpKty5j7WbP682yjLipoGeZNo/SqHUZUqt1YLvowTPZRTdz7Xw0/WBztjMWaERgAAAABJRU5ErkJggg=='); background-size: cover; display: block;\"\n  ></span>\n  <img\n        class=\"gatsby-resp-image-image\"\n        alt=\"directory-tree\"\n        title=\"directory-tree\"\n        src=\"/TIL/static/c2c8d1dde2a36c0f5f11e58d71d538bb/bb630/542-directory-tree.png\"\n        srcset=\"/TIL/static/c2c8d1dde2a36c0f5f11e58d71d538bb/5ea4d/542-directory-tree.png 238w,\n/TIL/static/c2c8d1dde2a36c0f5f11e58d71d538bb/466da/542-directory-tree.png 475w,\n/TIL/static/c2c8d1dde2a36c0f5f11e58d71d538bb/bb630/542-directory-tree.png 496w\"\n        sizes=\"(max-width: 496px) 100vw, 496px\"\n        style=\"width:100%;height:100%;margin:0;vertical-align:middle;position:absolute;top:0;left:0;\"\n        loading=\"lazy\"\n        decoding=\"async\"\n      />\n  </a>\n    </span></p>\n<blockquote>\n<p><code class=\"language-text\">base.py</code> 파일은 모든 환경에서 공통으로 사용되는 설정을 포함한다.</p>\n</blockquote>\n<h4>5.4.3 local.py, prod.py 설정</h4>\n<p><code class=\"language-text\">local.py</code> 파일과 <code class=\"language-text\">prod.py</code> 파일은 각각 개발, 운영 환경에서만 필요한 설정을 포함하면 되는데, 나는 아래처럼 설정했다.</p>\n<div class=\"gatsby-highlight\" data-language=\"python\"><pre class=\"language-python\"><code class=\"language-python\"><span class=\"token comment\"># local.py</span>\r\n<span class=\"token comment\"># 기본 설정 그대로 사용</span>\r\n\r\n<span class=\"token keyword\">from</span> <span class=\"token punctuation\">.</span>base <span class=\"token keyword\">import</span> <span class=\"token operator\">*</span></code></pre></div>\n<div class=\"gatsby-highlight\" data-language=\"python\"><pre class=\"language-python\"><code class=\"language-python\"><span class=\"token comment\"># prod.py</span>\r\n<span class=\"token comment\"># 운영서버에서는 DEBUG 를 False 로 설정해야 한다</span>\r\n\r\n<span class=\"token keyword\">from</span> <span class=\"token punctuation\">.</span>base <span class=\"token keyword\">import</span> <span class=\"token operator\">*</span>\r\n\r\n<span class=\"token comment\"># SECURITY WARNING: don't run with debug turned on in production!</span>\r\nDEBUG <span class=\"token operator\">=</span> <span class=\"token boolean\">False</span></code></pre></div>\n<h4>5.4.4 local.py 를 사용하여 테스트서버 실행하기</h4>\n<p>방금전에 생성한 <code class=\"language-text\">local.py</code> 를 사용하여 테스트 서버를 실행한다.<br>\n아래 사진처럼 <code class=\"language-text\">Environment variables</code> 옵션에 <code class=\"language-text\">DJANGO_SETTINGS_MODULE=config.settings.local</code> 를 추가해주면 이 설정파일로 테스트 서버가 실행된다.</p>\n<p><span\n      class=\"gatsby-resp-image-wrapper\"\n      style=\"position: relative; display: block; margin-left: auto; margin-right: auto; max-width: 950px; \"\n    >\n      <a\n    class=\"gatsby-resp-image-link\"\n    href=\"/TIL/static/2e43cc180ed7f5f95eee268ae366738e/1e5d2/544-django-server-settings.png\"\n    style=\"display: block\"\n    target=\"_blank\"\n    rel=\"noopener\"\n  >\n    <span\n    class=\"gatsby-resp-image-background-image\"\n    style=\"padding-bottom: 64.70588235294117%; position: relative; bottom: 0; left: 0; background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAANCAYAAACpUE5eAAAACXBIWXMAABYlAAAWJQFJUiTwAAABx0lEQVQ4y4VTy3LTQBD0BwEnV1LWWtr3SlqtLMsECEkMX8D/H5vqsWQnEIpD16hmZ3p6Htp8nQu6U0ZKPawPcCHCxgTtI2I/4On8E4/PZ3x/+YGHxyeELsOGBBtbmMVeERI2d2FAO3+DLSdsTcKHnUbjI1xq0ZUR7VCQ8gDtA3a1lkSSutShdh6+7RG6Xny19dh8qiPuQ8bW9ti6Hh+VQ6Ud+nJAm4sQ740TAoLqqYwdrFYQImrrsGmMhaob7BstqLWBaowEUY3SVpQ5UdYjdhmh7WEWwguitCsKWb1qLCq9oDECtuJTJ5ZkjGMC0Tgi3Kz10C6gNm4lNKJELYRKm2V+oySQZC30P/yTMOUipKtvv7wz/g3oW/x8f5eQLVAdN8zFMKYtI8b5hDLNGKYZ+TAJhumI4XCU4tz6+4QuiEKCc6QvlHwZQy7Xs7nOOF1u8tVS3hLygUfNjTKQPp4LE11LkguRv353CH2Wy1gItZyKajSqWgvhpeVRlDCQqkjS+HC7veWbHd0UxoIqTVBxhEpHVK5btnyQGa5t5nESQt4kFf9tDXbcsu8ylPHyd1SrfTWCP7HO+Pj5ixQw3kOFjLuHX7gvZ/wGKvLPSBEHrNoAAAAASUVORK5CYII='); background-size: cover; display: block;\"\n  ></span>\n  <img\n        class=\"gatsby-resp-image-image\"\n        alt=\"django-server-settings\"\n        title=\"django-server-settings\"\n        src=\"/TIL/static/2e43cc180ed7f5f95eee268ae366738e/906b5/544-django-server-settings.png\"\n        srcset=\"/TIL/static/2e43cc180ed7f5f95eee268ae366738e/5ea4d/544-django-server-settings.png 238w,\n/TIL/static/2e43cc180ed7f5f95eee268ae366738e/466da/544-django-server-settings.png 475w,\n/TIL/static/2e43cc180ed7f5f95eee268ae366738e/906b5/544-django-server-settings.png 950w,\n/TIL/static/2e43cc180ed7f5f95eee268ae366738e/010c2/544-django-server-settings.png 1425w,\n/TIL/static/2e43cc180ed7f5f95eee268ae366738e/1e5d2/544-django-server-settings.png 1630w\"\n        sizes=\"(max-width: 950px) 100vw, 950px\"\n        style=\"width:100%;height:100%;margin:0;vertical-align:middle;position:absolute;top:0;left:0;\"\n        loading=\"lazy\"\n        decoding=\"async\"\n      />\n  </a>\n    </span></p>\n<p>운영서버를 실행할 때에는 gunicorn 에 <code class=\"language-text\">DJANGO_SETTINGS_MODULE=config.settings.prod</code> 라는 옵션을 추가하면 된다.</p>\n<h2>6. drf 시작하기</h2>\n<p>커스텀한 <code class=\"language-text\">User</code> 모델을 api 를 통해 조회하는 예제를 만들어봤다.</p>\n<h3>6.1 /config/urls.py</h3>\n<p>management app 의 <code class=\"language-text\">urls.py</code> 파일을 불러오는 구문을 추가한다</p>\n<div class=\"gatsby-highlight\" data-language=\"python\"><pre class=\"language-python\"><code class=\"language-python\">\r\nurlpatterns <span class=\"token operator\">=</span> <span class=\"token punctuation\">[</span>\r\n    path<span class=\"token punctuation\">(</span><span class=\"token string\">'admin/'</span><span class=\"token punctuation\">,</span> admin<span class=\"token punctuation\">.</span>site<span class=\"token punctuation\">.</span>urls<span class=\"token punctuation\">)</span><span class=\"token punctuation\">,</span>\r\n    path<span class=\"token punctuation\">(</span><span class=\"token string\">''</span><span class=\"token punctuation\">,</span> include<span class=\"token punctuation\">(</span><span class=\"token string\">'management.urls'</span><span class=\"token punctuation\">)</span><span class=\"token punctuation\">)</span><span class=\"token punctuation\">,</span>\r\n<span class=\"token punctuation\">]</span></code></pre></div>\n<h3>6.2 /management/urls.py<a id='6.2-/management/urls.py'></a></h3>\n<p><code class=\"language-text\">rest_framework.routers</code> 의 <code class=\"language-text\">DefaultRouter</code> 를 사용해 URL 패턴을 정의한다.</p>\n<div class=\"gatsby-highlight\" data-language=\"python\"><pre class=\"language-python\"><code class=\"language-python\"><span class=\"token keyword\">from</span> django<span class=\"token punctuation\">.</span>urls <span class=\"token keyword\">import</span> path<span class=\"token punctuation\">,</span> include\r\n<span class=\"token keyword\">from</span> rest_framework<span class=\"token punctuation\">.</span>routers <span class=\"token keyword\">import</span> DefaultRouter\r\n\r\n<span class=\"token keyword\">from</span> <span class=\"token punctuation\">.</span>views <span class=\"token keyword\">import</span> api_views\r\n\r\nrouter <span class=\"token operator\">=</span> DefaultRouter<span class=\"token punctuation\">(</span><span class=\"token punctuation\">)</span>\r\n\r\nrouter<span class=\"token punctuation\">.</span>register<span class=\"token punctuation\">(</span><span class=\"token string\">r'user'</span><span class=\"token punctuation\">,</span> api_views<span class=\"token punctuation\">.</span>UserModelViewSet<span class=\"token punctuation\">,</span> basename<span class=\"token operator\">=</span><span class=\"token string\">'user'</span><span class=\"token punctuation\">)</span>\r\n\r\n\r\nurlpatterns <span class=\"token operator\">=</span> <span class=\"token punctuation\">[</span>\r\n    <span class=\"token comment\"># api</span>\r\n    path<span class=\"token punctuation\">(</span><span class=\"token string\">'api/'</span><span class=\"token punctuation\">,</span> include<span class=\"token punctuation\">(</span>router<span class=\"token punctuation\">.</span>urls<span class=\"token punctuation\">)</span><span class=\"token punctuation\">)</span><span class=\"token punctuation\">,</span>\r\n<span class=\"token punctuation\">]</span></code></pre></div>\n<h3>6.3 /management/models.py</h3>\n<p>장고에서 사용될 모델을 정의한다. 나는 <code class=\"language-text\">User</code> 모델을 커스텀하여 사용하기로 했기 때문에 <code class=\"language-text\">User</code> 클래스를 작성했다.</p>\n<div class=\"gatsby-highlight\" data-language=\"python\"><pre class=\"language-python\"><code class=\"language-python\"><span class=\"token keyword\">from</span> django<span class=\"token punctuation\">.</span>contrib<span class=\"token punctuation\">.</span>auth<span class=\"token punctuation\">.</span>base_user <span class=\"token keyword\">import</span> AbstractBaseUser\r\n<span class=\"token keyword\">from</span> django<span class=\"token punctuation\">.</span>db <span class=\"token keyword\">import</span> models\r\n\r\n\r\n<span class=\"token keyword\">class</span> <span class=\"token class-name\">User</span><span class=\"token punctuation\">(</span>AbstractBaseUser<span class=\"token punctuation\">)</span><span class=\"token punctuation\">:</span>\r\n    username <span class=\"token operator\">=</span> <span class=\"token boolean\">None</span>\r\n    email <span class=\"token operator\">=</span> models<span class=\"token punctuation\">.</span>EmailField<span class=\"token punctuation\">(</span>unique<span class=\"token operator\">=</span><span class=\"token boolean\">True</span><span class=\"token punctuation\">)</span>\r\n\r\n    USERNAME_FIELD <span class=\"token operator\">=</span> <span class=\"token string\">'email'</span>\r\n    REQUIRED_FIELDS <span class=\"token operator\">=</span> <span class=\"token punctuation\">[</span><span class=\"token punctuation\">]</span>\r\n\r\n    <span class=\"token keyword\">class</span> <span class=\"token class-name\">Meta</span><span class=\"token punctuation\">:</span>\r\n        db_table <span class=\"token operator\">=</span> <span class=\"token string\">'auth_user'</span>\r\n        verbose_name <span class=\"token operator\">=</span> <span class=\"token string\">'사용자'</span></code></pre></div>\n<h3>6.4 /management/filters.py</h3>\n<p>drf 의 <code class=\"language-text\">filter</code> 는 API 가 쿼리셋에서 반환하는 항목을 제한 할 수 있다.<br>\n예를들어, 특정 날짜에 가입한 회원만 반환한다던가 몇살 이상 회원만 반환 하도록 할 수 있다.</p>\n<p>지금은 <code class=\"language-text\">filter</code> 의 기능이 필요 없지만 사용가능하도록 간략히 작성했다.</p>\n<div class=\"gatsby-highlight\" data-language=\"python\"><pre class=\"language-python\"><code class=\"language-python\"><span class=\"token keyword\">import</span> django_filters\r\n<span class=\"token keyword\">from</span> django_filters <span class=\"token keyword\">import</span> FilterSet\r\n\r\n<span class=\"token keyword\">from</span> <span class=\"token punctuation\">.</span>models <span class=\"token keyword\">import</span> User\r\n\r\n\r\n<span class=\"token keyword\">class</span> <span class=\"token class-name\">UserFilter</span><span class=\"token punctuation\">(</span>FilterSet<span class=\"token punctuation\">)</span><span class=\"token punctuation\">:</span>\r\n\t<span class=\"token keyword\">class</span> <span class=\"token class-name\">Meta</span><span class=\"token punctuation\">:</span>\r\n\t\tmodel <span class=\"token operator\">=</span> User\r\n\t\tfields <span class=\"token operator\">=</span> <span class=\"token punctuation\">[</span><span class=\"token string\">'email'</span><span class=\"token punctuation\">]</span></code></pre></div>\n<h3>6.5 /management/serializers.py</h3>\n<p><code class=\"language-text\">serializers</code> 는 쿼리셋이나 모델 인스턴스를 파이썬 데이터 형태로 변경해준다.<br>\n또한, 모델 인스턴스의 특정 필드만을 반환하거나 데이터 형식(날짜 등)을 변환하여 반환 하도록 할 수 있다.</p>\n<p>아래 예제는 <code class=\"language-text\">User</code> 모델에서 <code class=\"language-text\">id</code>, <code class=\"language-text\">email</code>, <code class=\"language-text\">password</code> 필드를 반환하도록 만든 <code class=\"language-text\">serializers</code> 이다.</p>\n<div class=\"gatsby-highlight\" data-language=\"python\"><pre class=\"language-python\"><code class=\"language-python\"><span class=\"token keyword\">from</span> rest_framework <span class=\"token keyword\">import</span> serializers\r\n\r\n<span class=\"token keyword\">from</span> <span class=\"token punctuation\">.</span>models <span class=\"token keyword\">import</span> User\r\n\r\n\r\n<span class=\"token keyword\">class</span> <span class=\"token class-name\">UserSerializer</span><span class=\"token punctuation\">(</span>serializers<span class=\"token punctuation\">.</span>ModelSerializer<span class=\"token punctuation\">)</span><span class=\"token punctuation\">:</span>\r\n    <span class=\"token keyword\">class</span> <span class=\"token class-name\">Meta</span><span class=\"token punctuation\">:</span>\r\n        model <span class=\"token operator\">=</span> User\r\n        fields <span class=\"token operator\">=</span> <span class=\"token punctuation\">[</span><span class=\"token string\">'id'</span><span class=\"token punctuation\">,</span> <span class=\"token string\">'email'</span><span class=\"token punctuation\">,</span> <span class=\"token string\">'password'</span><span class=\"token punctuation\">]</span></code></pre></div>\n<h3>6.6 /management/views/viewsets.py</h3>\n<p><code class=\"language-text\">viewset</code> 는 클래스 형태의 뷰이다. <code class=\"language-text\">.get()</code> 이나 <code class=\"language-text\">.post()</code> 같은 메서드 대신에 <code class=\"language-text\">.list()</code> 나 <code class=\"language-text\">.create()</code> 같은 액션을 지원한다.</p>\n<p>아래 예제는 지금까지 생성한 <code class=\"language-text\">UserFilter</code>, <code class=\"language-text\">User</code> 모델, <code class=\"language-text\">UserSerializer</code> 를 사용하는 <code class=\"language-text\">Viewset</code> 예제이다.</p>\n<div class=\"gatsby-highlight\" data-language=\"python\"><pre class=\"language-python\"><code class=\"language-python\"><span class=\"token keyword\">from</span> django_filters<span class=\"token punctuation\">.</span>rest_framework <span class=\"token keyword\">import</span> DjangoFilterBackend\r\n<span class=\"token keyword\">from</span> rest_framework<span class=\"token punctuation\">.</span>viewsets <span class=\"token keyword\">import</span> ModelViewSet\r\n\r\n<span class=\"token keyword\">from</span> management<span class=\"token punctuation\">.</span>filters <span class=\"token keyword\">import</span> UserFilter\r\n<span class=\"token keyword\">from</span> management<span class=\"token punctuation\">.</span>models <span class=\"token keyword\">import</span> User\r\n<span class=\"token keyword\">from</span> management<span class=\"token punctuation\">.</span>serializers <span class=\"token keyword\">import</span> UserSerializer\r\n\r\n\r\n<span class=\"token keyword\">class</span> <span class=\"token class-name\">UserModelViewSet</span><span class=\"token punctuation\">(</span>ModelViewSet<span class=\"token punctuation\">)</span><span class=\"token punctuation\">:</span>\r\n    queryset <span class=\"token operator\">=</span> User<span class=\"token punctuation\">.</span>objects<span class=\"token punctuation\">.</span><span class=\"token builtin\">all</span><span class=\"token punctuation\">(</span><span class=\"token punctuation\">)</span>\r\n    filter_backends <span class=\"token operator\">=</span> <span class=\"token punctuation\">[</span>DjangoFilterBackend<span class=\"token punctuation\">]</span>\r\n    filterset_class <span class=\"token operator\">=</span> UserFilter\r\n    serializer_class <span class=\"token operator\">=</span> UserSerializer</code></pre></div>\n<h2>7. 결과 확인</h2>\n<p><a href=\"#6.2-/management/urls.py\">6.2</a> 에서 등록한 대로 주소창에 입력해보면 아래 사진처럼 API 화면을 확인할 수 있다.</p>\n<blockquote>\n<p>ex) example.com/api/user/</p>\n</blockquote>\n<p><span\n      class=\"gatsby-resp-image-wrapper\"\n      style=\"position: relative; display: block; margin-left: auto; margin-right: auto; max-width: 950px; \"\n    >\n      <a\n    class=\"gatsby-resp-image-link\"\n    href=\"/TIL/static/c6878efa9bdf2fa3be75858e9984f460/1cc3c/700-drf-page.png\"\n    style=\"display: block\"\n    target=\"_blank\"\n    rel=\"noopener\"\n  >\n    <span\n    class=\"gatsby-resp-image-background-image\"\n    style=\"padding-bottom: 50.42016806722689%; position: relative; bottom: 0; left: 0; background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAKCAYAAAC0VX7mAAAACXBIWXMAABYlAAAWJQFJUiTwAAABGElEQVQoz53R3UrDMBjG8Vzt3IfWyxI88A48VBA88kAQBuucol1X2tomefNR/pLOHW/z4McTSPLkhajrLCPJsozFYsFkMjnDBbPplMv53tV8hrJtS1fXNE2D0ZoY4+lCoOkt67LjY9ex2fWopm3ZVRVVVVHXNSJCjMPRspA44XVdcvOw4u4p5/ZxhSqKLV/fW3ot9NpijGCNjHmUdXjnIYa9IaLy/J1l/snnthn9dAZrTyw0gv4bJNFGUCIOEY93Ae/DmO5cPqUf76thGPiXGMcMIriuQ2uNtRZljCEpy3L8FO89zrnTiWC1xlmNF4tKzUlRFGNhOpR++hzeCW+bknVRo9KYqTBtHNZp4sNDpwjOcv+y4XlZ8AtVXOYTKdm/VwAAAABJRU5ErkJggg=='); background-size: cover; display: block;\"\n  ></span>\n  <img\n        class=\"gatsby-resp-image-image\"\n        alt=\"drf-page\"\n        title=\"drf-page\"\n        src=\"/TIL/static/c6878efa9bdf2fa3be75858e9984f460/906b5/700-drf-page.png\"\n        srcset=\"/TIL/static/c6878efa9bdf2fa3be75858e9984f460/5ea4d/700-drf-page.png 238w,\n/TIL/static/c6878efa9bdf2fa3be75858e9984f460/466da/700-drf-page.png 475w,\n/TIL/static/c6878efa9bdf2fa3be75858e9984f460/906b5/700-drf-page.png 950w,\n/TIL/static/c6878efa9bdf2fa3be75858e9984f460/010c2/700-drf-page.png 1425w,\n/TIL/static/c6878efa9bdf2fa3be75858e9984f460/a88f6/700-drf-page.png 1900w,\n/TIL/static/c6878efa9bdf2fa3be75858e9984f460/1cc3c/700-drf-page.png 2322w\"\n        sizes=\"(max-width: 950px) 100vw, 950px\"\n        style=\"width:100%;height:100%;margin:0;vertical-align:middle;position:absolute;top:0;left:0;\"\n        loading=\"lazy\"\n        decoding=\"async\"\n      />\n  </a>\n    </span></p>\n<h2>References</h2>\n<p><a href=\"https://docs.djangoproject.com/ko/4.0/intro/tutorial01/\">1. django 튜토리얼</a><br>\n<a href=\"https://forum.djangoproject.com/t/project-naming-conventions/339/12\">1. 프로젝트 이름을 config 로 사용한 이유</a><br>\n<a href=\"https://www.django-rest-framework.org/api-guide/routers/\">6.2 Routers</a><br>\n<a href=\"https://www.django-rest-framework.org/api-guide/filtering/\">6.4 Filtering</a><br>\n<a href=\"https://www.django-rest-framework.org/api-guide/serializers/\">6.5 Serializers</a><br>\n<a href=\"https://www.django-rest-framework.org/api-guide/viewsets/\">6.6 Viewsets</a></p>","frontmatter":{"title":"drf 사용하여 API 만들기","date":"July 22, 2022","description":null},"fields":{"category":"django-rest-framework","slug":"/django-rest-framework/django-start-with-drf/"}},"previous":{"fields":{"slug":"/tmp/custom-user-model/"},"frontmatter":{"title":"장고 user 모델 커스텀하기"}},"next":{"fields":{"slug":"/git/git-commit-reset/"},"frontmatter":{"title":"깃 커밋 리셋하기"}}},"pageContext":{"id":"38d9b1a9-26ba-536e-bf45-12021e4e2a87","previousPostId":"c395d58c-b611-5514-bcbc-461100a5e800","nextPostId":"f81b5e60-3562-5ac0-8d9c-7f8f8a603bf7"}},
    "staticQueryHashes": ["230163734","2841359383","3496359572"]}