python web接口实现(restful方式、jsonrpc方式)

准备把自己写的烂网站重构一下,让有些功能能接口分离。之前照着flask web开发这本书的教程来时,因为是新手所以用最简单的方式来实现,当时就不会去考虑前后端分离 !!!∑(゚Д゚ノ)ノ

现在JSON是大势所趋的主流,所以我的前后端传的都是JSON格式数据。

后端python: 使用的flask库和第三方扩展,以登录页面的登录接口为例子,因为只是简单例子,所以不包含model部分,只做简单的逻辑处理。

前端的ajax: 我都用的是jquery实现,所以需得导入 jquery

restful风格的接口实现例子

1、前端ajax:

<script type="text/javascript">
$(function () {
    $('.btn').click(function () {
        var $email=$('input[name="email"]').val();
        var $password=$('input[name="password"]').val();
        $.ajax({
            url:'/api/login',
            data:JSON.stringify({'email':$email,'password':$password}),
            type:'POST',
            dataType:'json',
            contentType:'application/json',
        }).done(function (data) {
                 if (!data.r){
                    alert('ok');
                }
                else{
                    alert('error');
                }
            });
    });
});
</script>

对class为btn的buttun元素添加点击事件,从而获取输入的账号、密码,再通过jquery的ajax方法发出json格式的请求,
最后通过done回调函数获取返回的data,判断返回的值来弹出提示。
note:发出的data,要通过json.stringify转换为字符串

2、后端python实现:

@app.route('/api/login',methods=['POST'])
def login():
    json=request.get_json()
    email=json.get('email')
    password=json.get('password')
    if email=='tang@163.com' and password=='tmhrush':
        return jsonify({'r':0,"rs":'ok'})
    else:
        return jsonify({'r':1,"rs":'is error'})

通过request.get_json获取json请求,通过jsonify函数返回序列化为json的数据

jsonrpc接口的实现例子:

1、前端ajax,

只需要把请求的data参数内容done回调函数的内容改为jsonrpc规范的格式就可以了
例如:
data内容:

data:JSON.stringify({"jsonrpc": "2.0", "method": "login", "params": {'email':$email,'password':$password} , "id": 1})

回调函数done内容:

done(function (data) {
                 if ('reuslt' in data ){
                    alert('ok');
               }
                else{
                    alert('error');
                }
            });

2、后端python实现:

用的flask_jsonrpc第三方扩展
其中有一个我觉得的小坑:
flask_jsonrpc 源码中JSONRPC类的构造函数中参数app默认为None,但同时其中有这段代码

if app is not None:
    self.app = app
    self.init_app(self.app)
else:
    self.app = None

因为要实例化jsonrpc( JSONRPC类 )对象必须要传入app(flask实例)参数
所以有不能在工厂函数create_app中实例 jsonrpc的问题,单独在 api.py页面中实例

from flask_jsonrpc import JSONRPC
from flask import jsonify
from .manage import app

jsonrpc = JSONRPC(app, service_url='/api')

@jsonrpc.method('login')
def login ():
     json=request.get_json()
    email=json.get('email')
    password=json.get('password')
    if email=='tang@163.com' and password=='tmhrush':
        return {'r':0,"rs":'ok'}
    else:
        return {'r':1,"rs":'is error'}

通过jsonrpc.method建立视图函数和URL接口的映射

from app.manage import manager

from app import api
#导入依赖模板

if __name__=='__main__':
    manager.run()

note:在主模块中导入api模块

3、总结

以上就是这两种接口的实现方法。
在我看来jsonrpc方式虽然麻烦一下,但更适合做内部程序的webapi接口,RPC协议使用二进制编码,流量消耗小网络性能更好。而且RPC就像本地调用方法,添加接口很方便。

所以我觉得对外开放的WEB接口适合用restful风格;而内部接口jsonrpc更适合,而且rpc规范中对异常错误处理感觉很工程化

首发于我的个人网站文章,http://www.valkyrie233.com/post/3

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

推荐阅读更多精彩内容