python web接口实现（restful方式、jsonrpc方式）

小文0111

restful风格的接口实现例子

1、前端ajax:

1. 
   
2. <script type="text/javascript">
   
3. $(function () {
   
4.     $('.btn').click(function () {
   
5.         var $email=$('input[name="email"]').val();
   
6.         var $password=$('input[name="password"]').val();
   
7.         $.ajax({
   
8.             url:'/api/login',
   
9.             data:JSON.stringify({'email':$email,'password':$password}),
   
10.             type:'POST',
    
11.             dataType:'json',
    
12.             contentType:'application/json',
    
13.         }).done(function (data) {
    
14.                  if (!data.r){
    
15.                     alert('ok');
    
16.                 }
    
17.                 else{
    
18.                     alert('error');
    
19.                 }
    
20.             });
    
21.     });
    
22. });
    
23. </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实现：

1. @app.route('/api/login',methods=['POST'])
   
2. def login():
   
3.     json=request.get_json()
   
4.     email=json.get('email')
   
5.     password=json.get('password')
   
6.     if email=='tang@163.com' and password=='tmhrush':
   
7.         return jsonify({'r':0,"rs":'ok'})
   
8.     else:
   
9.         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内容：

1. 
   
2. done(function (data) {
   
3.                  if ('reuslt' in data ){
   
4.                     alert('ok');
   
5.                }
   
6.                 else{
   
7.                     alert('error');
   
8.                 }
   
9.             });

复制代码

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页面中实例

1. 
   
2. from flask_jsonrpc import JSONRPC
   
3. from flask import jsonify
   
4. from .manage import app
   
5. 
   
6. jsonrpc = JSONRPC(app, service_url='/api')
   
7. 
   
8. @jsonrpc.method('login')
   
9. def login ():
   
10.      json=request.get_json()
    
11.     email=json.get('email')
    
12.     password=json.get('password')
    
13.     if email=='tang@163.com' and password=='tmhrush':
    
14.         return jsonify({'r':0,"rs":'ok'})
    
15.     else:
    
16.         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规范中对异常错误
处理感觉很工程化。