第十阶段 -- Flask框架05：【Flask高级06：Restful接口】

最新推荐文章于 2025-03-22 17:36:47 发布
原创 最新推荐文章于 2025-03-22 17:36:47 发布 · 574 阅读 · 2 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

本文详细介绍了 RESTful API 的设计理念与规范，并通过 Flask 框架及 Flask-Restful 插件展示了如何在实际项目中实现 RESTful API。文章涵盖了参数验证、返回标准化参数等高级功能。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

文章目录

1. RESTful接口规范

  1. Restful接口规范介绍
  • REST：Representational State Transfer，
  • REST 指的是一组架构约束条件和原则。满足这些约束条件和原则的应用程序或设计就是 RESTful。
  • 是一种软件架构风格、设计风格，而不是标准，只是提供了一组设计原则和约束条件。
  • 它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁，更有层次。
  • restful接口规范是用于在前端与后台进行通信的一套规范。使用这个规范可以让前后端开发变得更加轻松。

  1. 适用场景：一个系统的数据库数据，展现的平台有PC端、移动端、app端、ios端。

    前端工程师：都遵循RESTful编程规范

    后端工程师：都遵循RESTful编程规范

    最终结果：开发效率高，便于管理

  2. 协议：用http或者https协议。

  3. 数据传输格式：数据传输的格式应该都用 json 格式。

  4. url链接规则：

    url链接中，不能有动词，只能有名词。

    并且对于一些名词，如果出现复数，那么应该在后面加s。

    比如：获取新闻列表，应该使用/news/，而不应该使用/get_news/

  5. HTTP请求方式：

  • GET：从服务器上获取资源。

  • POST：在服务器上新增或者修改一个资源。

  • PUT：在服务器上更新资源。（客户端提供所有改变后的数据）

  • PATCH：在服务器上更新资源。（客户端只提供需要改变的属性）

  • DELETE：从服务器上删除资源。

  1. 状态码：
状态码原因描述描述
200OK服务器成功响应客户端的请求。
400INVALID REQUEST用户发出的请求有错误，服务器没有进行新建或修改数据的操作
410INVALID REQUEST用户没有权限访问这个请求
403Forbidden因为某些原因禁止访问这个请求
404NOT FOUND用户请求的url不存在
406NOT Acceptable用户请求不被服务器接收（比如服务器期望客户端发送某个字段，但是没有发送）。
500NOT FOUND服务器内部错误，比如遇到bug

2. RESTful的基本使用

1.介绍：

优势：

  • Flask-Restful是一个专门用来写restful api的一个插件。

  • 使用它可以快速的集成restful api接口功能。

  • 在系统的纯api的后台中，这个插件可以帮助我们节省很多时间。

    缺点：

  • 如果在普通的网站中，这个插件就没有优势了，因为在普通的网站开发中，是需要去渲染HTML代码的，

  • 而Flask-Restful在每个请求中都是返回json格式的数据。

  1. 安装：
pip install flask-restful

  1. 基本使用：

    定义Restful的类视图：

    1. 从flask_restful中导入Api，来创建一个api对象。
    2. 写一个类视图，让他继承自Resource类，然后在这个里面，使用你想要的请求方式来定义相应的方法，比如你想要将这个类视图只能采用post请求，那么就定义一个post方法。
    3. 使用api.add_resource来添加类视图与url。
from flask import Flask,url_for,render_template
from flask_restful import  Api,Resource
app = Flask(__name__)
api = Api(app)

class LoginView(Resource):
    def post(self):
        return {"flag":"yes"}
    def get(self):
        return {"flag":"no"}

# api.add_resource(LoginView,'/login/')
api.add_resource(LoginView,'/login/','/login2/',endpoint="login")

with app.test_request_context():
     # print(url_for('loginview'))
     print(url_for('login'))
@app.route('/')
def hello_world():
    return render_template('index.html')

if __name__ == '__main__':
    app.run(debug=True)
  1. 注意：
  • 如果你想返回json数据，那么就使用flask_restful，如果你是想渲染模版，那么还是采用之前的方式，就是 app.route 的方式。
  • url还是跟之前的一样，可以传递参数。也跟之前的不一样，可以指定多个url。
  • endpoint是用来给url_for反转url的时候指定的。如果不写endpoint，那么将会使用视图的名字的小写来作为endpoint。

3. 参数验证

  1. 参数验证：（也叫参数解析） Flask-Restful插件提供了类似WTForms来验证提交的数据是否合法的包，叫做reqparse。

  2. 基本用法：（借助于测试工程师 常用的接口测试工具postman来检验）

from flask import Flask,url_for,render_template
from flask_restful import Api,Resource,reqparse,inputs
app = Flask(__name__)
api = Api(app)

class RegisterView(Resource):
    def post(self):
        #验证用户名
        # 1.创建解析器对象
        parser = reqparse.RequestParser()
        # 2.利用解析器对象添加 需要验证的参数
        parser.add_argument('uname',type=str,help='用户名验证错误！',required=True,trim=True)
                # 3.利用解析器对象进行验证，若正确，直接返回验证后合格的参数值，若错误，抛异常信息给客户端
        args = parser.parse_args()
        print(args)
        return {"tips":"注册成功"}

api.add_resource(RegisterView,'/register/')

@app.route('/')
def hello_world():
    return render_template('index.html')

if __name__ == '__main__':
    app.run(debug=True)
  1. 其中 add_argument 方法使用详解：

  • add_argument方法可以指定这个字段的名字，这个字段的数据类型等，验证错误提示信息等，具体如下：

  • default：默认值，如果这个参数没有值，那么将使用这个参数指定的默认值。

  • required：是否必须。默认为False，如果设置为True，那么这个参数就必须提交上来。

  • type：这个参数的数据类型，如果指定，那么将使用指定的数据类型来强制转换提交上来的值。

  • choices：固定选项。提交上来的值只有满足这个选项中的值才符合验证通过，否则验证不通过。

  • help：错误信息。如果验证失败后，将会使用这个参数指定的值作为错误信息。

  • trim：是否要去掉前后的空格。

其中的type：

  • 可以使用python自带的一些数据类型(如str或者int)，
  • 也可以使用flask_restful.inputs下的一些特定的数据类型来强制转换。
  • 比如一些常用的：
    1. url：会判断这个参数的值是否是一个url，如果不是，那么就会抛出异常。
    2. regex：正则表达式。
    3. date：将这个字符串转换为datetime.date数据类型。如果转换不成功，则会抛出一个异常。
from flask import Flask,url_for,render_template
from flask_restful import Api,Resource,reqparse,inputs
app = Flask(__name__)
api = Api(app)

#Flask_RESTful功能之参数验证
class RegisterView(Resource):
    def post(self):
        #用户名   密码   年龄 性别  出生日期   号码  个人主页
        # 1.创建解析器对象
        parser = reqparse.RequestParser()
        #2.利用解析器对象添加 需要验证的参数
        parser.add_argument('uname',type=str,help='用户名验证错误！',required=True,trim=True)
        parser.add_argument('pwd', type=str, help='密码验证错误！',default="123456")
        parser.add_argument('age',type=int,help='年龄验证错误！')
        parser.add_argument('gender',type=str,choices=['男','女','双性'])
        parser.add_argument('birthday',type=inputs.date,help='生日字段验证错误！')
        parser.add_argument('phone',type=inputs.regex(r'1[3578]\d{9}'))
        parser.add_argument('phomepage',type=inputs.url,help='个人中心链接验证错误！')
        #3.利用解析器对象进行验证，若正确，直接返回验证后合格的参数值，若错误，抛异常信息给客户端
        args = parser.parse_args()
        print(args)
        return {"tips":"注册成功"}

api.add_resource(RegisterView,'/register/')

@app.route('/')
def hello_world():
    return render_template('index.html')

if __name__ == '__main__':
    app.run(debug=True)

4. 返回标准化参数

Flask_RESTful返回标准化参数：

  • 对于一个类视图，你可以指定好一些字段作标准化用于返回。
  • 以后使用ORM模型或者自定义模型的时候，他会自动的获取模型中的相应的字段，生成json格式数据，然后再返回给客户端。
  • 这需要导入 flask_restful.marshal_with 装饰器。
  • 还需要写一个字典变量，来指定需要返回的标准化字段，以及该字段的数据类型。
  • 在get方法中，返回自定义对象的时候，flask_restful 会自动的读取对象模型上的所有属性。
  • 组装成一个符合标准化参数的json格式字符串返回给客户端。

代码演示：

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

# flask_restful返回标准化参数
class News(object):
    def __init__(self,title,content):
        self.title =title
        self.content =content

news = News('能力强的体现','能屈能伸')

class NewsView(Resource):
    resource_fields ={
        'title': fields.String,
        'content':fields.String
    }
    @marshal_with(resource_fields)
    def get(self):
        # restful规范中，要求，定义好了返回的参数个数 和 内容
        # return {'title':"世界太大",'content':"可钱包太小"}
        #好处01：体现规范化，即使content这个参数没有值，也应该返回，返回一个null回去
        # return {'title':"世界太大"}
        #好处02：体现规范化，还可以返回一个对象模型回去
        return news

api.add_resource(NewsView,'/news/')

if __name__ == '__main__':
    app.run(debug=True)

5. 返回标准化参数强化

  1. 重命名属性和默认值：

  • 需求1：有的时候你对外给出的属性名和模型内部的属性名不相同时，可使用 attribute 可以配置这种映射。

    比如想要返回模型对象user.username 的值，但是在返回给外面的时候，想以uname 返回去。

  • 需求2：在返回某些字段的时候，有时候可能没有值，但想给一个值用以提示，那么这时候可以在指定 fields 的时候使用 default 指定默认值

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

# flask_restful返回标准化参数强化
class User():
    def __init__(self,username,age):
        self.username=username
        self.age=age
        self.signature=None

class UserView(Resource):
    resource_fields={
        # 01.重命名属性
        'uname':fields.String(attribute='username'),
        'age':fields.Integer,
        # 02.默认值
        'signature':fields.String(default='此人很懒，什么也没写')
    }

    @marshal_with(resource_fields)
    def get(self):
        user = User('莫莫',18)
        return user

api.add_resource(UserView,'/user/')

if __name__ == '__main__':
    app.run(debug=True)

  1. 复杂的参数结构：大型的互联网项目中，返回的数据格式，是比较复杂的结构。如：小米商城，

    https://www.mi.com/

    https://a.huodong.mi.com/flashsale/getslideshow

    总结，无非就是key对应的value又是一个json，或者key对应的是一个列表，列表中的每项都是json那么可以使用一些特殊的字段来实现。如在一个字段中放置一个列表，那么可以使用 fields.List，如在一个字段下面又是一个字典，那么可以使用 fields.Nested。

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

# flask_restful返回标准化参数强化
# 复杂的参数结构
# 实体间关系有   1：1   1:n    n:n(转为2个1:n)
# 新闻系统后台；用户；新闻；新闻标签
class User():
    def __init__(self,id,uname,age):
        self.id = id
        self.uname = uname
        self.age = age
    def __repr__(self):
        return "<User:{id},{uname},{age}>".format(id=self.id, uname=self.uname,age=self.age)

class News():
    def __init__(self,id,title,content):
        self.id=id
        self.title=title
        self.content=content
        #关系映射
        self.author=None
        self.tags=[]
    def __repr__(self):
        return "<News:{id},{title},{content},{author},{tags}>"\
            .format(id=self.id, title=self.title,content=self.content,author=self.author,tags=self.tags)

class NewsTag():
    def __init__(self,id,name):
        self.id=id
        self.name=name
    def __repr__(self):
        return '<NewsTage:{id},{name}>'.format(id =self.id , name=self.name)

def createData():
    user = User(110,'莫莫',30)
    tag1 = NewsTag(200,"要闻")
    tag2 = NewsTag(210,"娱乐")
    news =News(300,'吴京征服了世界上海拔最高的派出所','4月23日中午11点，吴京发了一条微博，配文“世界上海拔最高的派出所”，并@了另外一名演员张译。微博中有两张图片，第一张是吴京和张译两人坐在地上的合照，背后几个大字“中国边防”。第二张则是两人与派出所民警们的合照。 ')
    news.author = user   #绑定新闻作者
    news.tags.append(tag1) #绑定新闻标签1
    news.tags.append(tag2) #绑定新闻标签2
    print(news)
    return news

class NewsView2(Resource):
    resource_fields={
        'id':fields.Integer,
        'title': fields.String,
        'content': fields.String,
        # 如在一个字段下面又是一个字典，那么可以使用fields.Nested({...})
        'author': fields.Nested({
            'id': fields.Integer,
            'uname': fields.String,
            'age':fields.Integer
        }),
        # 如要在一个字段中放置一个列表，那么可以使用fields.List(fields.Nested({...}))
        'tags': fields.List(fields.Nested({
            'id': fields.Integer,
            'name': fields.String
        }))
    }

    @marshal_with(resource_fields)
    def get(self):
        news = createData()
        return news

api.add_resource(NewsView2,'/news2/')

if __name__ == '__main__':
    app.run(debug=True)

6. 结合蓝图使用和渲染模板

  1. Flask_RESTful结合蓝图使用：在蓝图中，如果使用Flask_RESTful，那么在创建Api对象的时候，使用蓝图对象，不再是使用app对象了

【蓝图 news.py 文件】

from flask import url_for,render_template,Blueprint,make_response,Response
from flask_restful import Api,Resource,reqparse,inputs,fields,marshal_with
import json
news_bp = Blueprint('news',__name__,url_prefix='/news')
api = Api(news_bp)
# 01.flask-restful结合蓝图使用

# 复杂的参数结构
# 实体间关系有   1：1   1:n    n:n(转为2个1:n)
# 新闻系统后台  用户  新闻   新闻标签
class User():
    def __init__(self,id,uname,age):
        self.id = id
        self.uname = uname
        self.age = age
    def __repr__(self):
        return "<User:{id},{uname},{age}>".format(id=self.id, uname=self.uname,age=self.age)

class News():
    def __init__(self,id,title,content):
        self.id=id
        self.title=title
        self.content=content
        #关系映射
        self.author=None
        self.tags=[]
    def __repr__(self):
        return "<News:{id},{title},{content},{author},{tags}>"\
            .format(id=self.id, title=self.title,content=self.content,author=self.author,tags=self.tags)

class NewsTag():
    def __init__(self,id,name):
        self.id=id
        self.name=name
    def __repr__(self):
        return '<NewsTage:{id},{name}>'.format(id =self.id , name=self.name)

def createData():
    user = User(110,'莫莫',30)
    tag1 = NewsTag(200,"要闻")
    tag2 = NewsTag(210,"娱乐")
    news =News(300,'吴京征服了世界上海拔最高的派出所','4月23日中午11点，吴京发了一条微博，配文“世界上海拔最高的派出所”，并@了另外一名演员张译。微博中有两张图片，第一张是吴京和张译两人坐在地上的合照，背后几个大字“中国边防”。第二张则是两人与派出所民警们的合照。 ')
    news.author = user   #绑定新闻作者
    news.tags.append(tag1) #绑定新闻标签1
    news.tags.append(tag2) #绑定新闻标签2
    print(news)
    return news

class NewsView2(Resource):
    resource_fields={
        'id':fields.Integer,
        'title': fields.String,
        'content': fields.String,
        #如在一个字段下面又是一个字典，那么可以使用fields.Nested({...})
        'author': fields.Nested({
            'id': fields.Integer,
            'uname': fields.String,
            'age':fields.Integer
        }),
        #如要在一个字段中放置一个列表，那么可以使用fields.List(fields.Nested({...}))
        'tags': fields.List(fields.Nested({
            'id': fields.Integer,
            'name': fields.String
        }))
    }

    @marshal_with(resource_fields)
    def get(self):
        news = createData()
        return news

api.add_resource(NewsView2,'/news2/')

【app.py 文件】

from flask import Flask,url_for,render_template

from blueprints.news import news_bp
app = Flask(__name__)
app.register_blueprint(news_bp)

@app.route('/')
def hello_world():
    return render_template('index.html')

if __name__ == '__main__':
    app.run(debug=True)
  1. Flask_RESTful渲染模版：如果在Flask_RESTful的类视图中想要返回html片段代码，或者是整个html文件代码，即渲染模版的意思。那么就应该使用api.representation这个装饰器来定义一个函数，在这个函数中，应该对html代码进行一个封装，再返回。v
from flask import url_for,render_template,Blueprint,make_response,Response
from flask_restful import Api,Resource,reqparse,inputs,fields,marshal_with
import json
news_bp = Blueprint('news',__name__,url_prefix='/news')
api = Api(news_bp)

# 02. 使用flask-restful渲染模版
class ListView(Resource):
    def get(self):
        return render_template('index.html')
api.add_resource(ListView,'/list/')

# 渲染模版经过修改后，能支持html和json
@api.representation('text/html')
def output_html(data,code,headers):
    if isinstance(data,str):
        # 在representation装饰的函数中，必须返回一个Response对象
        # resp = make_response(data)
        resp =Response(data)
        return resp
    else:
        return Response(json.dumps(data),mimetype='application/json')

7. 示例

【34_flask_restful_demo.py】

from flask import Flask,url_for
from flask_restful import Api,Resource,reqparse,inputs,fields,marshal_with
from datetime  import  date
from blueprints.news import news_bp
app = Flask(__name__)
# api = Api(app)  #此写法适用于 在当前文件中使用flask_restful写接口
# date(year=,month=,day=)

app.register_blueprint(news_bp)

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

# Flask_RESTful的基本使用
# 定义一个类视图
# class  LoginView(Resource):
#     def get(self):
#         return {"flag":'no'}
#     def post(self):
#         return {"flag":"yes"}
# #映射url
# # api.add_resource(LoginView,'/login/','/login2/')
# api.add_resource(LoginView,'/login/','/login2/',endpoint="login")

# with app.test_request_context():
#     # print(url_for('loginview')) #如果不写endpoint，那么将会使用视图的名字的小写来作为endpoint。
#     print(url_for('login')) #如果指定了endpoint，就必须使用endpoint的值来构建url

# Flask_RESTful功能之参数验证  基本用法
# class RegisterView(Resource):
#     def post(self):
#         #用户名  uname
#         #1.创建一个解析器对象
#         parse = reqparse.RequestParser()
#         #2.利用解析器对象 添加需要验证的参数  并指定验证规则
#         parse.add_argument('uname',type =str,help="用户名不符合规则！！",required=True,trim=True)
#         #3.利用解析器对象 进行验证 若正确，直接返回验证后合格的参数值，若错误，抛异常信息给客户端
#         args =parse.parse_args()
#         #若验证成功后，需要插入数据库
#         print(args)
#         return {'tips':"注册成功"}
#
# api.add_resource(RegisterView,'/register/')

# Flask_RESTful功能之参数验证  更多用法
# class RegisterView(Resource):
#     def post(self):
#         #用户名   密码   年龄 性别  出生日期   号码  个人主页
#         # 1.创建解析器对象
#         parser = reqparse.RequestParser()
#         #2.利用解析器对象添加 需要验证的参数
#         parser.add_argument('uname',type=str,help='用户名验证错误！',required=True,trim=True)
#         parser.add_argument('pwd', type=str, help='密码验证错误！',default="123456")
#         parser.add_argument('age',type=int,help='年龄验证错误！')
#         parser.add_argument('gender',type=str,choices=['男','女','双性'],help="性别只能是男 或者女  。。。")
#         parser.add_argument('birthday',type=inputs.date,help='生日字段验证错误！')
#         parser.add_argument('phone',type=inputs.regex(r'1[3578]\d{9}'))
#         parser.add_argument('phomepage',type=inputs.url,help='个人中心链接验证错误！')
#         #3.利用解析器对象进行验证，若正确，直接返回验证后合格的参数值，若错误，抛异常信息给客户端
#         args = parser.parse_args()
#         print(args)
#         return {"tips":"注册成功"}
#
# api.add_resource(RegisterView,'/register/')

#flask_restful返回标准化参数
# class News(object):
#     def __init__(self,title,content):
#         self.title =title
#         self.content =content
#
# class NewsView(Resource):
#     # restful规范中，要求，定义好了返回的参数个数 和 内容
#     resource_fields = {
#         'title': fields.String,
#         'content': fields.String
#     }
#     @marshal_with(resource_fields)
#     def get(self):
#         # return {'title':"世界太大",'content':"可钱包太小"}
#         # 好处1：体现规范化，即使content这个参数没有值，也应该返回，返回一个null回去
#         # return {'title':"世界太大"}
#         # 好处2：体现规范化，还可以返回一个对象模型回去
#         news = News('能力强的体现', '能屈能伸')
#         return news
#
# api.add_resource(NewsView,'/news/')

# flask_restful返回标准化参数强化   1.重命名属性和默认值：
# class User():
#     def __init__(self,username,age):
#         self.username=username
#         self.age=age
#         # self.signature=None
#         self.signature='天道酬勤！！'
#
# class UserView(Resource):
#     resource_fields={
#         #1.重命名属性
#         'uname':fields.String(attribute='username'),
#         'age':fields.Integer,
#         #2.默认值
#         'signature':fields.String(default='此人很懒，什么也没写')
#     }
#
#     @marshal_with(resource_fields)
#     def get(self):
#         user = User('莫莫',18)
#         return user
#
# api.add_resource(UserView,'/user/')

# flask_restful返回标准化参数强化    2.复杂的参数结构
# 复杂的参数结构
# 实体间关系有   1：1   1:n    n:n(转为2个1:n)
# 新闻系统后台  用户  新闻   新闻标签
# class User():
#     def __init__(self,id,uname,age):
#         self.id = id
#         self.uname = uname
#         self.age = age
#     # __str__ 和 __repr__
#     def __repr__(self):
#         return "<User:{id},{uname},{age}>".format(id=self.id, uname=self.uname,age=self.age)
#
# class News():
#     def __init__(self,id,title,content):
#         self.id=id
#         self.title=title
#         self.content=content
#         #关系映射
#         self.author=None
#         self.tags=[]
#     def __repr__(self):
#         return "<News:{id},{title},{content},{author},{tags}>"\
#             .format(id=self.id, title=self.title,content=self.content,author=self.author,tags=self.tags)
#
# class NewsTag():
#     def __init__(self,id,name):
#         self.id=id
#         self.name=name
#     def __repr__(self):
#         return '<NewsTage:{id},{name}>'.format(id =self.id , name=self.name)
#
# def createData():
#     user = User(110,'莫莫',30)
#     tag1 = NewsTag(200,"要闻")
#     tag2 = NewsTag(210,"娱乐")
#     news =News(300,'吴京征服了世界上海拔最高的派出所','4月23日中午11点，吴京发了一条微博，配文“世界上海拔最高的派出所”，并@了另外一名演员张译。微博中有两张图片，第一张是吴京和张译两人坐在地上的合照，背后几个大字“中国边防”。第二张则是两人与派出所民警们的合照。 ')
#     news.author = user   #绑定新闻作者
#     news.tags.append(tag1) #绑定新闻标签1
#     news.tags.append(tag2) #绑定新闻标签2
#     print(news)
#     return news
#
# class NewsView2(Resource):
#     resource_fields={
#         'id':fields.Integer,
#         'title': fields.String,
#         'content': fields.String,
#         #如在一个字段下面又是一个字典，那么可以使用fields.Nested({...})
#         'author': fields.Nested({
#             'id': fields.Integer,
#             'uname': fields.String,
#             'age':fields.Integer
#         }),
#         #如要在一个字段中放置一个列表，那么可以使用fields.List(fields.Nested({...}))
#         'tags': fields.List(fields.Nested({
#             'id': fields.Integer,
#             'name': fields.String
#         }))
#     }
#
#     @marshal_with(resource_fields)
#     def get(self):
#         news = createData()
#         return news
#
# api.add_resource(NewsView2,'/news2/')

# 1.Flask_RESTful结合蓝图使用
# 2.Flask_RESTful渲染模版

if __name__ == '__main__':
    app.run(debug=True)

【news.py】

from flask  import  Blueprint,render_template,make_response,Response
from flask_restful import Api,Resource,reqparse,inputs,fields,marshal_with
news_bp = Blueprint('news',__name__,url_prefix='/news')
api = Api(news_bp)  # 此写法适用于 在蓝图文件中使用flask_restful写接口
import json
class User():
    def __init__(self,id,uname,age):
        self.id = id
        self.uname = uname
        self.age = age
    # __str__ 和 __repr__
    def __repr__(self):
        return "<User:{id},{uname},{age}>".format(id=self.id, uname=self.uname,age=self.age)

class News():
    def __init__(self,id,title,content):
        self.id=id
        self.title=title
        self.content=content
        #关系映射
        self.author=None
        self.tags=[]
    def __repr__(self):
        return "<News:{id},{title},{content},{author},{tags}>"\
            .format(id=self.id, title=self.title,content=self.content,author=self.author,tags=self.tags)

class NewsTag():
    def __init__(self,id,name):
        self.id=id
        self.name=name
    def __repr__(self):
        return '<NewsTage:{id},{name}>'.format(id =self.id , name=self.name)

def createData():
    user = User(110,'莫莫',30)
    tag1 = NewsTag(200,"要闻")
    tag2 = NewsTag(210,"娱乐")
    news =News(300,'吴京征服了世界上海拔最高的派出所','4月23日中午11点，吴京发了一条微博，配文“世界上海拔最高的派出所”，并@了另外一名演员张译。微博中有两张图片，第一张是吴京和张译两人坐在地上的合照，背后几个大字“中国边防”。第二张则是两人与派出所民警们的合照。 ')
    news.author = user   #绑定新闻作者
    news.tags.append(tag1) #绑定新闻标签1
    news.tags.append(tag2) #绑定新闻标签2
    print(news)
    return news

class NewsView2(Resource):
    resource_fields={
        'id':fields.Integer,
        'title': fields.String,
        'content': fields.String,
        # 如在一个字段下面又是一个字典，那么可以使用fields.Nested({...})
        'author': fields.Nested({
            'id': fields.Integer,
            'uname': fields.String,
            'age':fields.Integer
        }),
        # 如要在一个字段中放置一个列表，那么可以使用fields.List(fields.Nested({...}))
        'tags': fields.List(fields.Nested({
            'id': fields.Integer,
            'name': fields.String
        }))
    }

    @marshal_with(resource_fields)
    def get(self):
        news = createData()
        return news

api.add_resource(NewsView2,'/news2/')

# 02. 使用flask-restful渲染模版
class ListView(Resource):
    def get(self):
        return render_template('index.html')

api.add_resource(ListView,'/list/')


# 渲染模版经过修改后，能支持html和json
@api.representation('text/html')
def out_html(data,code,headers):
    if isinstance(data, str):
        # 在representation装饰的函数中，必须返回一个Response对象
        # resp = make_response(data)
        resp = Response(data)
        return resp
    else:
        return Response(json.dumps(data), mimetype='application/json')

【index.html】

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
   <h2>flask_restful渲染模版的注意事项</h2>
</body>
</html>
Flask--RestfulApi接口开发
记录小白的成长之路
09-25 5808
文章目录简介Flask-Restful下载API开发第一个api实例参数验证解析add_argument类方法解析参数限制参数长度和格式add_argument()常用参数parse_args()接受参数的数据类型参数的判断模拟实例场景数据读取和写入的准备封装一个随机生成字符串方法登录login接口我的主页info接口 简介 $$ REST又被称为表征性状态传输，是指在客户端与服务端之间传输信息的一种方式，在WEB的应用程序 中，一般都是基于HTTP的REST服务，这样的好处是可以使用应用层的协议来方便的实
Flask教程6：使用Flask-restful构建restful API
Cachel Wood的博客
06-08 1473
首先，提供了一致的API设计方式。它采用了一种简洁而直观的方式来定义路由和处理请求。通过使用装饰器或类视图，开发人员可以轻松地将URL映射到相应的处理函数上。这种设计方式使得API的结构更加清晰，易于理解和维护。其次，简化了请求处理的过程。它提供了一系列的请求解析器，可以自动解析请求中的数据并将其转换为适当的数据类型。这样，开发人员就不需要手动解析请求参数，而是可以直接使用解析后的数据进行业务逻辑的处理。除了上述功能之外，还提供了其他一些有用的功能。
Flask 编写Restful 接口
weixin_41244495的博客
09-06 319
# 环境介绍 : win10 + python3.7 +flask # 要注意几个点 请求方式 ， 序列化方式， 入参的处理 # 下面设置路由和参数 from flask_restful import Api api = Api() # 初始化api对象 def init_api(app): api.init_app(app) # 在项目初始化的地方传入app 对象 api.add_resource(HelloResource, '/hello/') #...
Flask restful接口（七）
z_ipython的博客
08-08 438
安装 pip install flask-restful 接口简单使用案例 # import os import pymysql from flask import Flask from flask import session from flask_sqlalchemy import SQLAlchemy from flask_wtf import CSRFProtect # 导入csrf校验...
使用flask_restful快速构建接口
最新发布
xueyu188的博客
03-22 1170
在 Flask-RESTful 中，你可以使用fields模块和装饰器来定义和控制 API 响应的格式。这允许你指定哪些字段应该包含在输出中，以及这些字段的数据类型和格式在上面的代码中,我们原始数据中的age是字符类型,但是我们定义的返回是整型,最终调用接口发现结果还是整型证明在返回的过程中,marshal_with装饰器对result的内容进行了与resource_fields类型匹配与转化,如果我们把age改为String看结果。
利用Flask搭建Restful接口
02-08 248
项目需要访问Restful接口获取数据，程序开发过程中，用Flask实现了一个简单的RestFul接口。 from flask import Flask app = Flask(__name__) @app.route('/test') def test(): return 'thi...
基于Flask的RESTful API实战代码：集成Flask-SQLAlchemy与MySQL
03-25
项目概述：本项目是一个基于Python语言的实战项目，使用了Flask框架构建RESTful API。它集成了Flask-SQLAlchemy作为ORM工具与MySQL数据库进行交互。项目共包含39个文件，其中主要的Python脚本文件有23个，辅助配置...
flask-restful-login：Flask Restful服务包括注册，登录，注销，重置密码和一些数据路由。 它包括一些基于用户，管理员或超级管理员访问权限的示例路由
02-05
flask-restful-login-example 安装 需要Python 3。 有多种方法可以将请求发送到服务器。 邮递员，失眠，cURL，httpie和curl是发送请求的简单而有用的工具。 我最喜欢httpie和curl。 用法如下所示。 将项目和安装...
flask-restx-boilerplate：:fire:使用Flask-RESTX框架以Flask微型Web框架编写的REST API
02-06
一个使用Flask-RESTX（以前称为Flask-RESTPlus）的REST样板。 它具有常用的API功能，可帮助您入门和入门，并且还易于扩展和扩展。 我之所以写这个样板，是因为我发现很多Flask REST样板要么做得太多，要么做不到，...
flask-restx：Flask-RESTPlus的Fork：功能齐全的框架，用于通过Flask快速，轻松地进行文档化的API开发
01-30
Flask本身是一个轻量级的Python Web服务器网关接口（WSGI）应用框架，而Flask-RESTX则扩展了它的功能，特别是在RESTful API的创建和文档化方面。 首先，让我们深入理解Flask-RESTX的一些核心特性： 1. **RESTful...
Python中Flask-RESTful编写API接口(小白入门)
09-18
主要介绍了Python中Flask-RESTful编写API接口(小白入门)，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
flask-restful-example：flask的开发接口示例，利用Flask开发的API接口。包含基本的项目配置，统一响应，MySQL和Redis数据库操作，定时任务，图片生成，项目部署，用户权限认证，报表输出，无限层级生成目录树，阿里云手机验证码验证，微信授权，Celery，单元测试，Drone等模块
02-05
烧瓶的例子 flask基本的开发接口示例，利用Flask开发的API接口。包含基本的项目配置，统一响应，MySQL和Redis数据库操作，定时任务，图片生成，项目部署，用户权限认证，报表输出，无限层级生成目录树，阿里云手机验证码验证，微信授权，Celery，单元测试，Drone等模块。 一，系列文章 二，部署 1.拉取代码 切换到/projects目录（没有就先新建目录sudo mkdir /projects ），执行命令cd /projects 执行命令sudo git clone https://github.com/qzq1111/flask-restful-example.git拉取代
用flask写的一个restfulapi实例
08-10
restful_api是关于restful API的实践使用，用flask实践开发一个restful API的实际案例
flask Restful API规范
weixin_45735361的博客
05-25 750
restful api是用于在前端与后台进行通信的一套规范。使用这个规范可以让前后端开发变得更加轻松。以下将讨论这套规范的一些设计细节。 协议 采用http或者https协议 数据传输格式 数据之间传输的格式应该都使用json，而不使用xml。 url链接 url链接中，不能有动词，只能有名词。并且对于一些名词，如果出现复数，那么应该在后面加s。 HTTP请求的方法 GET：从服务器上获取资源。 POST：在服务器上新创建一个资源。 PUT：在服务器上更新资源。（客户端提供所有改变后的数据） PATCH：
Flask类视图和RESTful--05
运维有三宝，重启、重装、踹一脚
04-17 130
Flask类视图和RESTful--05
python flask高级编程之restful_Flask实现RESTful API(示例代码)
weixin_33242795的博客
03-01 600
准备工作首先安装flask_restful三方组件pip install flask_restful在models.py中新建一个类，生成表，往里面插入一些数据。(flask要想使用ORM的话需要安装flask_sqlalchemy三方组件，之前已经说过了，此处不再赘述)然后写了一个urls文件，实例化我们的api，把api对象和app绑定，然后在__init__.py加入绑定的函数具体实现api...
[flask]Restful编写简单的接口
limy_liu的博客
03-06 286
#!/usr/bin/env python # -*- coding: utf-8 -*- # @Author : LMY from flask import Flask,make_response,jsonify from flask_restful import Resource,Api,reqparse '''实例化Flask这个类''' app = Flask(__name__) ...
Flask-Restful插件，看看如何写接口
Eric的博客
08-29 223
Flask-Restful插件 介绍： 今天跟大家介绍一下flask中一个插件——Flask-Restful！ Flask-Restful是一个专门用来写restful api的一个插件。使用他可以快速的集成restful api功能。在app的后台以及纯api的后台中，这个插件可以帮助我们节省很多时间。当然，如果在普通的网站中，这个插件就显得有些鸡肋了，因为在普通的网页开发中，是需要去渲染HTML代码的，而Flask-Restful在每个请求中都是返回json格式的数据。 安装： Flask-Restfu
11.RESTFUL
only_Tokimeki的博客
09-26 277
Flask Restful Restful API规范介绍 restful api是用于在前端与后台进行通信的一套规范。使用这个规范可以让前后端开发变得更加轻松。 协议 采用http或https协议 数据传输格式 数据之间传输的格式应该都使用json，而不使用xml url连接 url连接中，不能有动词，并且对于一些名词，如果出现复数，那么应该在后面加s HTTP请求的方法 GET:从服务器上获...
Flask-RESTful 指南：快速构建REST API
快速启动部分将引导你创建第一个Flask-RESTful应用，通常涉及定义资源(Resource)和路由(Route)。 1.3 请求解析 Flask-RESTful提供了请求解析功能，允许你从HTTP请求中提取数据，如查询参数、路径参数、请求体等，...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值