您的位置：首页 > 编程技术 > python  >  flask项目集成swagger的方法

flask项目集成swagger的方法

 更新时间：2020年12月10日 10:46  点击：1453

 　　此次主要介绍介绍在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的资料请关注猪先飞其它相关文章！

[!--infotagslink--]

相关文章

  • Swagger中@ApiIgnore注解的使用详解

    这篇文章主要介绍了Swagger中@ApiIgnore注解的使用，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教...2021-10-21

  • python 实现Flask中返回图片流给前端展示

    今天小编就为大家分享一篇python 实现Flask中返回图片流给前端展示，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧...2020-04-27

  • c# webapi 配置swagger的方法

    这篇文章主要介绍了c# webapi 配置swagger的方法，文中示例代码非常详细，帮助大家更好的理解和学习，感兴趣的朋友可以了解下...2020-07-09

  • SpringMVC和rabbitmq集成的使用案例

    这篇文章主要介绍了SpringMVC和rabbitmq集成的使用案例，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧...2021-01-20

  • Swagger2匹配多个controller代码实例

    这篇文章主要介绍了Swagger2匹配多个controller代码实例,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-09-19

  • Python如何使用logging为Flask增加logid

    这篇文章主要介绍了Python如何使用logging为Flask增加logid，帮助大家更好的理解和学习使用python，感兴趣的朋友可以了解下...2021-03-30

  • python框架flask知识总结

    今天带大家复习python框架的相关知识,文中对flask作了非常详细的介绍,对正在学习python的小伙伴们有很好的帮助,需要的朋友可以参考下...2021-05-25

  • 关于springboot整合swagger问题及解决方法

    这篇文章主要介绍了关于springboot整合swagger问题及解决方法,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下...2021-04-20

  • flask开启多线程的具体方法

    在本篇内容里小编给大家整理的是一篇关于flask开启多线程的具体方法，对此有需求的可以学习参考下。...2020-08-03

  • 如何使用flask将模型部署为服务

    在某些场景下，我们需要将机器学习或者深度学习模型部署为服务给其它地方调用，本文接下来就讲解使用python的flask部署服务的基本过程。...2021-05-14

  • Flask response响应的具体使用

    在flask中，想要给前端页面返回数据，必须是Response的对象，本文介绍了Flask response响应的使用，感兴趣的可以了解一下...2021-07-15

  • asp.net core集成MongoDB的完整步骤

    前两天在学习MongoDB相关的知识，做了个小Demo，下面这篇文章主要给大家介绍了关于asp.net core集成MongoDB的相关资料，文中通过示例代码介绍的非常详细，需要的朋友可以参考下...2021-09-22

  • python 解决flask 图片在线浏览或者直接下载的问题

    今天小编就为大家分享一篇python 解决flask 图片在线浏览或者直接下载的问题，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧...2020-04-27

  • 详解springboot集成websocket的两种实现方式

    这篇文章主要介绍了springboot集成websocket的两种实现方式,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下...2021-01-25

  • Flask中sqlalchemy模块的实例用法

    在本篇文章里小编给大家整理了关于Flask中sqlalchemy模块的实例用法，需要的朋友们可以学习下。...2020-08-02

  • Spring集成Swagger常见错误及解决办法

    这篇文章主要介绍了Spring集成Swagger常见错误及解决办法，帮助大家更好的理解和学习使用Spring，感兴趣的朋友可以了解下...2021-05-03

  • 详解Springboot2.3集成Spring security 框架(原生集成)

    这篇文章主要介绍了详解Springboot2.3集成Spring security 框架(原生集成)，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧...2020-08-12

  • Python的Flask框架中SERVER_NAME域名项的配置教程

    SERVER_NAME项在Flask的路由配置中至关重要,特别是在配置绝对url和子域名的操作中,这里我们就来看一下Python的Flask框架中SERVER_NAME项的配置教程:...2020-06-30

  • 利用python实现后端写网页（flask框架）

    这篇文章主要给大家介绍了关于如何利用python实现后端写网页（flask框架）的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧...2021-02-28

  • vue 集成腾讯地图实现api(附DEMO)

    之前项目使用腾讯地图，不利于开发者查找，这篇文章主要介绍了vue 集成腾讯地图实现api，具有一定的参考价值，感兴趣的可以了解下...2021-07-14