flask项目集成swagger的方法

 更新时间:2020年12月09日 16:02:47   作者:种树飞  
这篇文章主要介绍了flask项目集成swagger的方法,帮助大家更好的理解和使用flask框架,感兴趣的朋友可以了解下

   此次主要介绍介绍在flask框架中如何集成swagger文档, 我们知道以前给同事提供接口文档主要是写一个文档, 当遇到频繁修改时,就需要更新文档非常麻烦, 这时swagger文档就出现了,一个在线得接口文档,同事可以在线上查看接口文档, 当需要修改接口时秩序修改对应得代码,文档也会随之更新。如下图所示。

  此次集成参考flask-restplus官方文档,flask-restplus框架是flask-restful框架的一个加强版, 类似django框架的rest framework框架,应用前得先安装框架执行命令:

pip install flask-restplus

  然后结合官网写个简单示例感受一下:

from flask import Flask
from flask_restplus import Api, Resource, fields, reqparse

app = Flask(__name__)
api = Api(app, version='1.0', title='TodoMVC API', description='A simple TodoMVC API',)

ns = api.namespace('todo', description='TODO operations')               # 模块命名空间

todo = api.model('Todo', {                               # 返回值模型
  'id': fields.Integer(readonly=True, description='The task unique identifier'),
  'task': fields.String(required=True, description='The task details')
})

parser = reqparse.RequestParser()                      # 参数模型
parser.add_argument('id', type=str, required=True, help="id")
parser.add_argument('name', type=str, required=True, help="名称")
parser.add_argument('volume', type=int, required=True, help="方量")


class TodoDAO(Resource):
  def __init__(self, *args, **kwargs):
    super().__init__(*args, **kwargs)
    self.params = parser.parse_args()

  @ns.expect(parser)                  # 用于解析对应文档参数,             
  @ns.response(200, "success response", todo)      # 对应解析文档返回值
  def get(self):
    return self.params


ns.add_resource(TodoDAO, "/to", endpoint="to_do")

app.run()

我们启动得地址为127.0.0.1:5000得地址, 然后我们只需在浏览器打开即可查看自己写好得api文档,如下图:

好了,至此我们已经集成好了swagger文档, 需要更详细得内容可以参考官网文档, 比方更改文档地址等。

以上就是flask项目集成swagger的方法的详细内容,更多关于flask项目集成swagger的资料请关注脚本之家其它相关文章!

相关文章

  • Python装饰器中@property使用详解

    Python装饰器中@property使用详解

    大家好,本篇文章主要讲的是Python装饰器中@property使用详解,感兴趣的同学赶快来看一看吧,对你有帮助的话记得收藏一下
    2022-01-01
  • Python入门之面向对象和类

    Python入门之面向对象和类

    这篇文章主要为大家介绍了Python面向对象和类,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-01-01
  • Pygame实战之实现经典外星人游戏

    Pygame实战之实现经典外星人游戏

    这篇文章主要介绍了通过Pygame实现经典的外星人游戏的示例代码,文中的代码讲解详细,对我们了解Pygame有一定的帮助,感兴趣的同学可以试一试
    2022-01-01
  • Python使用Pandas库实现MySQL数据库读写

    Python使用Pandas库实现MySQL数据库读写

    本次分享将介绍如何在Python中使用Pandas库实现MySQL数据库的读写,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-08-08
  • 详解Python flask的前后端交互

    详解Python flask的前后端交互

    这篇文章主要为大家详细介绍了Python flask的前后端交互,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-03-03
  • keras的backend 设置 tensorflow,theano操作

    keras的backend 设置 tensorflow,theano操作

    这篇文章主要介绍了keras的backend 设置 tensorflow,theano操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-06-06
  • Sublime Text v4.0(4143)安装方法

    Sublime Text v4.0(4143)安装方法

    这篇文章主要介绍了Sublime Text v4.0(4143)安装破解方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-02-02
  • Keras自定义实现带masking的meanpooling层方式

    Keras自定义实现带masking的meanpooling层方式

    这篇文章主要介绍了Keras自定义实现带masking的meanpooling层方式,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-06-06
  • 用Pygal绘制直方图代码示例

    用Pygal绘制直方图代码示例

    这篇文章主要介绍了用Pygal绘制直方图代码示例,具有一定借鉴价值,需要的朋友可以了解下。
    2017-12-12
  • vue常用指令代码实例总结

    vue常用指令代码实例总结

    这篇文章主要介绍了vue常用指令代码实例,需要的朋友可以参考下
    2020-03-03

最新评论