flask restful
web中最主要的两点 资源和表述
顾名思义 资源就是互联网上的各种资源,可以是文字 图片。。 表述就是一种表现手段
在web的世界中,主要是三个东西来支撑上面两点,分别是:
url http html分别用来 显示资源位置, 传输资源, 显示资源
例如
a的浏览器向https://www.baidu.com发送一条http请求,这个https://www.baidu.com
就是url ,利用http协议传输,上面的http后面的s意味着加了一个加密层,用来保护数据不被篡改。
服务器向浏览器返回资源后,浏览器解析,生成页面。浏览器生成就是所谓的表述。
http层是在计算机网络模型的最顶层 应用层,在http连接开始之前,还有很多的工作。
从最底层物理层开始 数据通过有线或者是无线的方式来给上层提供服务,数据链路层保证可靠点的传输。
然后到了ip层,计算机通过ip地址,来知道服务器在哪一个地方,从而可以获取数据。 但是浏览器发送的是一个
url,这时就要通过dns 发送一个udp包来获取ip。获取ip后还需要加上一个相应的端口。http的端口是80,通过ip加上
端口号形成套接字,从而能够发送数据了。
http协议的一大特性:
无状态性
服务器不需要关心客户端的状态
幂等性 多次请求和一次请求的状态是相同的。
Rest(表现层状态转移)六大特性
服务器 客户端 --有明确界限
无状态
缓存
接口统一
系统分层
按需代码
api设计流程
罗列语义描述符 将要表达资源写出来
画状态图 表达资源之间的联系
调整命名 命名规范
选择媒体类型 表达方式
写profile 文档
code
发布
在flask中,可以很方便的设计出api
认证:
因为 REST 架构基于 HTTP 协议,所以发送密令的最佳方式是使用 HTTP 认证,基本认证
和摘要认证都可以。在 HTTP 认证中,用户密令包含在请求的 Authorization 首部中。
使用flask-httpauth可以很简单实现认证
auth = HTTPBasicAuth()
@auth.verify_password 确认密码或者token
@auth.login_required 确认用户是否通过了认证
认证方式是将用户名和密码通过b64编码,加到authorization头中
在header中可以找到这样一条信息 Authorization:Basic ***********
使用requests 和 base64可以直接很方便的在客户端使用
from requests import get, post
import base64
code = base64.decode(用户名 密码)
header = {'Authorization':code}
get('url', headers=header)
认证完成后需要资源,可以选择使用三方库自动生成,也可以手动生成
手动将资源在模型类下生成为json格式的:
def to_json(self):
json_post = {
'url': url_for('api.get_post', id=self.id, _external=True),
'body': self.body,
'body_html': self.body_html,
'timestamp': self.timestamp,
'author': url_for('api.get_user', id=self.author_id,
_external=True),
'comments': url_for('api.get_post_comments', id=self.id,
_external=True)
'comment_count': self.comments.count()
}
return json_post
使用flask_restless可以很方便的生成
初始化
manager = APIManager(app, flask_sqlalchemy_db=db)
from my_app import manager
需要生成的资源
manager.create_api(Product, methods=['GET', 'POST', 'DELETE'])
manager.create_api(Category, methods=['GET', 'POST', 'DELETE'])
使用:
import requests
import json
res = requests.get('http://127.0.0.1:5000/api/category')
res.json()
{u'total_pages': 0, u'objects': [], u'num_results': 0, u'page': 1}
但是使用这样的方法有一个不好的地方,这样显示的是数据库的模型,但是用户
并不关心数据库是怎么样的。要面向用户设计
有一个更好的扩展 flask-restful
from flask_restful import Api
from flask_restful import reqparse, fields, marshal_with
api = Api(app)
这里可以自定义一个自己的基类。
method_decorators能够执行装饰器函数,可以不用在每个方法上都写装饰器。
主要是加一些访问控制装饰器。
这是实现:
def dispatch_request(self, *args, **kwargs):
# Taken from flask
#noinspection PyUnresolvedReferences
meth = getattr(self, request.method.lower(), None)
if meth is None and request.method == 'HEAD':
meth = getattr(self, 'get', None)
assert meth is not None, 'Unimplemented method %r' % request.method
for decorator in self.method_decorators:
meth = decorator(meth)
resp = meth(*args, **kwargs)
自定义
class Resource(restful.Resource)
version = 'v1'
method_decorators = []
required_scopes = {}
自定义自己的数据格式,fields提供了不同的方法能够将数据库中的数据转化为
我们规定的格式。
class APISchema():
"""describes input and output formats for resources,
and parser deals with arguments to the api.
"""
get_fields = {
'id': fields.Integer,
'created': fields.DateTime(dt_format='iso8601')
}
def __init__(self):
self.parser = reqparse.RequestParser()
def parse_args(self):
return self.parser.parse_args()
然后就可以实现自己想显示的格式了,例如:
class User(Resource):
schema = Schema()
model = models.User
/#marshal_with装饰器用来将输出的数据为我们定义的格式。
@marshal_with(schema.get_fields)
def get(self, id=None):
user = self.model.get_by_id(id)
data = {
'id': user.id,
'email': user.email,
'username': user.username,
'is_admin': user.is_admin,
'profile': user.profile,
}
return data
def post(self):
self.schema.auth_user()
return {'email':g.current_user.email}
最后添加url,api就可以使用了。
api.add_resource(User, '/v1/user', '/v1/user/<int:id>')
对于一般的应用,上面说的basic认证方式就够了,如果网站没有使用https的话,就需要
更安全的oauth认证。
Blog www.97up.cn