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数据库
异常捕获
日志系统
个人电脑环境与测试服务器环境与正式服务器环境如何区分.
购买服务器
配置服务器环境
持续集成相关配置与脚本编写.

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,519评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,842评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,544评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,742评论 1 271
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,646评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,027评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,513评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,169评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,324评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,268评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,299评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,996评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,591评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,667评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,911评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,288评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,871评论 2 341

推荐阅读更多精彩内容