Flask Restful

video 99 API规范

from flask_restful import Api,Resource

app = Flask(__name__)
api = Api(app)


@app.route('/')
def hello_world():
    return 'Hello World!'

class LoginView(Resource):
    def post(self):
        return {"username":"zhiliao"}
api.add_resource(LoginView,'/login/', endpoint="login")

video 101 

 检查表单：

先引入“from flask_restful import Api,Resource,reqparse”

class LoginView(Resource):
    def post(self):
        parser = reqparse.RequestParser()
        parser.add_argument('user', type=int,help='用户名错误')
        args = parser.parse_args()
        print(args)

        return {"username":"zhiliao"}
api.add_resource(LoginView,'/login/', endpoint="login")

然后用postman去模拟：

因为我们把user设置为int型，所以提示了help中的内容。

 

video 102 flask-restful标准化返回参数

1，最简单的API写法：

from flask_restful import Api,Resource
app = Flask(__name__)
api = Api(app)

@app.route('/')
def hello_world():
    return 'Hello World!'

class ArticleView(Resource):
    def get(self):
        return {"article":"xxx","title":"aaa"}
api.add_resource(ArticleView,'/article/',endpoint = 'article')

2，返回值定义

from flask_restful import Api,Resource,fields,marshal_with
app = Flask(__name__)
api = Api(app)

@app.route('/')
def hello_world():
    return 'Hello World!'

class ArticleView(Resource):
    resource_fields = {
        'article':fields.String,
        'title':fields.String,
    }
#marshal_with作用：连接resource_fields到视图。
#因为在resource_fields中定义好了返回的参数，即使这个参数没有值，也会返回，但返回一个None
#以上写法才是标准API
    @marshal_with(resource_fields)
    def get(self):
        return {"article":"xxx","title":"aaa"}
api.add_resource(ArticleView,'/article/',endpoint = 'article')

以上是返回字典，下面讲返回模型：

3，返回模型

from flask import Flask
from flask_restful import Api,Resource,fields,marshal_with
app = Flask(__name__)
api = Api(app)

@app.route('/')
def hello_world():
    return 'Hello World!'

#建立模型
class Article(object):
    def __init__(self,article,title):
        self.article = article
        self.title = title
article = Article(article='book1',title='chapter2')

class ArticleView(Resource):
    resource_fields = {
        'article':fields.String,
        'title':fields.String,
    }
#marshal_with作用：连接resource_fields到视图。
#因为在resource_fields中定义好了返回的参数，即使这个参数没有值，也会返回，但返回一个None
#以上写法才是标准API
    @marshal_with(resource_fields)
    def get(self):
        # return {"article":"xxx","title":"aaa"}
#Note：这里返回实例化对象就行。
        return article
api.add_resource(ArticleView,'/article/',endpoint = 'article')

29这里直接返回一个实例化后的模型就行。效果和之前一样：

video 103 标准化用法（开发过程中）

 

video 104 渲染模板

from flask_restful import Api,Resource
app = Flask(__name__)
api = Api(app)

class ListView(Resource):
    def get(self):
        return render_template("index.html")
api.add_resource(ListView,'/list/',endpoint='list')

在restful下渲染html。

结果发现：

那么，如何解决这个问题呢？

因为restful返回的时候都是倒数第二个json形式，所以出现上面的形式，参考下表：

所以我们需要修改他为html代码，就应该改为第一种html形式。

from flask import Flask,render_template,make_response
from flask_restful import Api,Resource
app = Flask(__name__)
api = Api(app)

#修改返回的类型
@api.representation('text/html')
def output_html(data,code,headers):
    print(data)
    #在representation装饰的函数中必须返回一个Response对象。
    # resp = make_response('hello')
    resp = make_response(data)
    return resp

class ListView(Resource):
    def get(self):
        return render_template("index.html")
api.add_resource(ListView,'/list/',endpoint='list')