django框架-写一个接口返回json

先介绍一个用来写接口的django三方库

djangorestframework
http://www.django-rest-framework.org

workon python35
pip install djangorestframework

终端切换环境python3.5的环境
安装djangorestframework

这个框架可以自动生成接口文档. 非常方便

pip安装完毕

打开项目
修改settings.py 文件
添加app
'rest_framework_swagger',
'rest_framework',
修改为
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'mytest',
'rest_framework_swagger',
'rest_framework',
]

修改
urls.py文件

from django.conf.urls import url
from django.contrib import admin
from rest_framework.schemas import get_schema_view

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'^docs/', get_schema_view())
]

运行项目到8000端口

访问
http://127.0.0.1:8000/docs/
试试发现默认的接口文档页面.

restframeworkschema.png

在实际的项目中还会修改或定制这个页面的样式. 查询restframework官网选你喜欢的风格吧...
我比较喜欢这个样子.

swagger0.png

模型转json

iOS开发中一般是Json转Model, 那么返回来服务端一定是Model转Json了.(其实json转Model也挺常用的)
python3.5自带json包 import json即可
我一般使用这个库来做Model->Json django-simple-serializer

workon python35
pip install django-simple-serializer

接下来写一个返回json的接口
在之前创建的项目中,打开mytest.views.py文件.
编辑文件为

from django.shortcuts import render
from rest_framework.views import APIView
from dss.Serializer import serializer
from django.http import HttpResponse, HttpRequest
# Create your views here.
def response_as_json(data, foreign_penetrate=False):
    jsonString = serializer(data=data, output_type="json", foreign=foreign_penetrate)
    response = HttpResponse(
            # json.dumps(dataa, cls=MyEncoder),
            jsonString,
            content_type="application/json",
    )
    response["Access-Control-Allow-Origin"] = "*"
    return response


def json_response(data, code=200, foreign_penetrate=False, **kwargs):
    data = {
        "code": code,
        "msg": "成功",
        "data": data,
    }
    return response_as_json(data, foreign_penetrate=foreign_penetrate)


def json_error(error_string="", code=500, **kwargs):
    data = {
        "code": code,
        "msg": error_string,
        "data": {}
    }
    data.update(kwargs)
    return response_as_json(data)

JsonResponse = json_response
JsonError = json_error
class ReturnJson(APIView):

    def get(self, request, *args, **kwargs):
        return JsonResponse("Hello world!!!!!!!!++++++中文测试")

JsonResponse和JsonError是我编写的两个工具.用来返回Json,他们中将模型转为Json的工具dss就是 django-simple-serializer
逻辑写好, 在urls中添加此接口.

修改与settings.py 文件同一目录下的urls.py文件修改为

from django.conf.urls import url
from django.contrib import admin
from rest_framework.schemas import get_schema_view
from mytest.views import ReturnJson


urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'^docs/', get_schema_view()),
    url(r'^api/getjson', ReturnJson.as_view()),
]

运行项目
浏览器中输入

http://127.0.0.1:8000/api/getjson

发现浏览器中显示

{
    "msg": "\u6210\u529f",
    "data": "Hello world!!!!!!!!++++++\u4e2d\u6587\u6d4b\u8bd5",
    "code": 200
}

自此一个简单的处理get请求的接口就完成了.

距离将项目实际部署到测试服务器还有多远?

swagger配置
修改接口文档访问权限
修改接口文档风格
将JsonResponse等等单独封装成tools
编写工具解析request中的参数(get, post参数位置不同),
get, post, put, patch, delete他们与多种提交形式中参数如何获取
http header Content-Type有很多种, 不同情况参数如何获取

application/x-www-form-urlencoded
multipart/form-data
application/json
text-plain

文件如何接收和存储. 例如图片上传.
更换到mysql数据库
异常捕获
日志系统
个人电脑环境与测试服务器环境与正式服务器环境如何区分.
购买服务器
配置服务器环境
持续集成相关配置与脚本编写.

我暂时想到的就这些...

作者：行如风
链接：https://www.jianshu.com/p/2d60bf3faf37
來源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。