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格式的请求，

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

对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参数内容和done回调函数的内容改为jsonrpc规范的格式就可以了
例如：

只需要把请求的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第三方扩展
其中有一个我觉得的小坑:

用的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实例）参数

因为要实例化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 jsonify({'r':0,"rs":'ok'})
    else:
        return jsonify({'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