用 Python Django REST 搭建 Web API 笔记

贡献者： addis

• Flask 是一个更加轻量级的 web api 库，一个教程见这里，包括什么是 web api。
• 用 django 做一个简单的 web form 见这里（以及它的预备知识Django 的 MVT 结构，创建 MVT 基本工程和创建 app）。
• django 基于 MVT（Model-View-Template） 的设计模式（design pattern）。
• Model：整个应用的数据结构和数据库。
• View：渲染用户界面（HTML/CSS/Javascript）。
• Template: HTML 模板，用一些特殊语法指定如何加载动态内容。
• Django 主要用于后端（虽然提供少量前端支持），前端可以用 React，Vue 等框架实现。
• Django REST framework（DRF） 是基于 django 的用于搭建 web api 的工具。
• Django REST quick start tutorial。下面我们按照这个教程来做。
• 创建文件夹 tutorial 并进入。
• 【可选】创建虚拟环境 python3 -m venv env，然后 source env/bin/activate 开启虚拟环境
• 在虚拟环境中 pip install django djangorestframework，大概需要安装 9MB 的包。
• 如果没有用虚拟环境，可能需要 export PATH=$PATH:/home/addis/.local/bin 把 pip 的可执行文件目录添加到路径。
• 当然应该也可以在 conda 中安装虚拟环境并安装。
• 创建新的 django project（注意后面有一点）：django-admin startproject tutorial . 名为 tutorial，该命令会创建同名文件夹
• 运行 cd tutorial; django-admin startapp quickstart; cd ..。会生成如图 1 的 quickstart 目录。
  
  图 1：quickstart 的目录结构
• python manage.py migrate
• python manage.py createsuperuser --email admin@example.com --username admin 交互创建密码
• 创建文件 tutorial/quickstart/serializers.py，插入代码…（见 GitHub）
• 替换文件 tutorial/quickstart/views.py 的代码…
• 替换文件 tutorial/urls.py 的代码…
• 在文件 vim tutorial/settings.py 最后插入代码…并在 INSTALLED_APPS 列表的最后插入一行…
• 现在启动 api python manage.py runserver。将在 localhost 端口运行。
• 现在就可以用 curl 测试我们的 web api 了：curl -H 'Accept: application/json; indent=4' -u admin:password123 http://127.0.0.1:8000/admin/ -o ret.html
• 或者直接访问 http://127.0.0.1:8000/users/