python-tornado的接口用swagger进行包装的实例

写这个文章的主要原因，就是因为没有相关的东西，导致我完全不知道应该怎么做，经过了两个晚上的摸索，终于搞清楚了，如果有谁需要tornado+swagger的输出模式，可以照这个套；

主要是static文件的生成

我们用swagger就是为了做一个静态页面，也就是生成一个static文件：

几个必备的工具：swagger-py-codegen我们不用他们的文件框架只需要其生成的static文件，拷贝到自己文件夹下即可；

1）需要注意的是生成文件需要用yaml文件，当编辑好文件后，最主要的是要注意base_path文件的改动，你生成的文件的请求会加上你basepath的内容，会造成请求出错， 比如 你的url:port/GET?testparas=test,那么如果说你的static文件生成的过程中,如下图所示

2）生成的文件，swagger-ui中的swagger.json文件是按照你的yaml文件生成的，index.html文件中是有地方设置swagger.json的地址的，如下图所示

3）这个时候我们可以启动我们的swagger程序，

接下来接受一下tornado中的一些设置，主要为application的设置：

在这里其实没用到tornado的高级方法，只是随意设置了一个参数进行测试：

`import tornado.web
import tornado.ioloop
import os

abs_path = os.path.dirname(os.path.abspath("__file__"))
print(abs_path)

class IndexHandler(tornado.web.RequestHandler):
 def get(self, *args, **kwargs):
  para = self.get_argument('test', None)
  self.write("test tornado {}".format(para))

if __name__ == '__main__':
 app = tornado.web.Application([
  (r'/GET', IndexHandler)
 ],
  static_path=os.path.join(abs_path, 'static')
 )
 # 监听端口
 app.listen(8000)
 tornado.ioloop.IOLoop.current().start()`

目录结构如下

生成swagger-ui的代码如下：

swagger_py_codegen -s api.yaml project-one -p demo -tlp=tornado --ui --spec

其中 –ui –spec是生成swagger-ui的关键代码

以上这篇python-tornado的接口用swagger进行包装的实例就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持我们。

赞 (0)

相关推荐

  • django-rest-swagger对API接口注释的方法

    Swagger是一个API开发者的工具框架,用于生成.描述.调用和可视化RESTful风格的Web服务.总体目标是使客户端和文件系统服务器以同样的速度来更新,方法,参数和模型紧密集成到服务器端的代码中,允许API始终保持同步. 在使用 django-rest-framework 进行API开发,可以使用django-rest-swagger接入swagger自动生成接口文档. 1. 安装django-rest-swagger pip install django-rest-swagger 2.配

  • python使用tornado实现简单爬虫

    本文实例为大家分享了python使用tornado实现简单爬虫的具体代码,供大家参考,具体内容如下 代码在官方文档的示例代码中有,但是作为一个tornado新手来说阅读起来还是有点困难的,于是我在代码中添加了注释,方便理解,代码如下: # coding=utf-8 #!/usr/bin/env python import time from datetime import timedelta try: from HTMLParser import HTMLParser from urlparse

  • 使用Python的Tornado框架实现一个Web端图书展示页面

    使用Python的Tornado框架实现一个Web端图书展示页面

    首先,为什么选择Tornado: 1.高性能的网络库,这可以和gevent,twisted,libevent等做对. 提供了异步io支持,超时事件处理,在此基础上提供了tcpserver,httpclient,尤其是curlhttpclient, 在现有http客户端中肯定排第一.可以用来做爬虫,游戏服务器,据我所知业界已有使用tornado作为游戏服务器 2.web框架,这可以和django,flask对. 提供了路由,模板等web框架必备组件.与其他区别是tornado是异步的,天然适合长轮

  • Python的Tornado框架异步编程入门实例

    Python的Tornado框架异步编程入门实例

    Tornado Tornado 是一款非阻塞可扩展的使用Python编写的web服务器和Python Web框架, 可以使用Tornado编写Web程序并不依赖任何web服务器直接提供高效的web服务.所以Tornado不仅仅是一个web框架而且还是一款可以用于生产环境的高效的web服务器 Torando 在Linux和FreeBSD上使用高效的异步I/O模型 epoll 和kqueue来实现高效的web服务器, 所以 tornado在Linux上和FreeBSD系列性能可以达到最高 接口 当然

  • python使用tornado实现登录和登出

    本文实例为大家分享了tornado实现登录和登出的具体代码,供大家参考,具体内容如下 main.py如下: import tornado.httpserver import tornado.ioloop import tornado.web import tornado.options import os.path from tornado.options import define, options define("port", default=8000, help="ru

  • python-tornado的接口用swagger进行包装的实例

    写这个文章的主要原因,就是因为没有相关的东西,导致我完全不知道应该怎么做,经过了两个晚上的摸索,终于搞清楚了,如果有谁需要tornado+swagger的输出模式,可以照这个套: 主要是static文件的生成 我们用swagger就是为了做一个静态页面,也就是生成一个static文件: 几个必备的工具:swagger-py-codegen我们不用他们的文件框架只需要其生成的static文件,拷贝到自己文件夹下即可: 1)需要注意的是生成文件需要用yaml文件,当编辑好文件后,最主要的是要注意ba

  • Python Tornado之跨域请求与Options请求方式

    问题背景 公司的项目是前后端分离,前端Vue+后端JavaSpringBoot为主,部分功能是PythonTornado,那么需要支持一个是跨域以及Options请求. Option请求 只需要跟处理get一样处理options请求就可以了.vue一般需要访问options方法, 如果报错则很难继续,所以只要通过就行了,当然需要其他逻辑就自己控制. #COM串口 class SerialHandler(BaseHandler): #处理GET请求 def get(self): self.writ

  • Python Tornado实现WEB服务器Socket服务器共存并实现交互的方法

    1.背景 最近有个项目,需要搭建一个socket服务器,一个web服务器,然后实现两个服务器之间的通讯交互.刚开始的方案是用Python中socket模块实现一个多线程的socket服务器,然后用Flask实现一个web服务器,他们之前通过线程交互实现通讯. 但是在我看来这个方案有例外一个更好的解决方法,就是用Torndao框架.鉴于网上用Tornado实现一个程序同时实现web服务和socket服务器并且实现交互的文章几乎没有,所以记录一下.觉得写得好麻烦点个赞,写得不好请指出,有疑问可以留言

  • Python Tornado框架轻松写一个Web应用的全过程

    Python Tornado框架轻松写一个Web应用的全过程

    目录 Tornado是什么 安装 试试看使用tornado框架来写一个web application 总结 Tornado是什么 学委之前在看Jupyter组件的源码的时候,发现了tornado这个web框架. 不仅仅做一个web框架, 通过使用非阻塞网络I/O,Tornado可以扩展到数万个开放连接. 这样非常适合long polling, WebSockets以及其他需要与每个用户建立长期连接的应用程序. 好,下面安装试用一下. 安装 pip install tornado pip 不会用的

  • Python优化列表接口进行分页示例实现

    目录 分页的目的 接口设计 接口解读 CaseService.get_case_list方法 CaseService.get_count方法 分页的目的 做个假设,加入用例库有 1W 条数据,如果想要以列表形式展示,一次性返回 1W 条数据: 这样做有两个弊端: 1.这样写出来的接口会慢.想一下如果随着时间的发展,这个数量变成了 10W.100W 该怎么办? 2.对前端不友好.用前端渲染 1W 条数据,有理智的开发都不会这么做. 所以,我们做分页的目的,主要是为了性能的提高,提高使用体验. 我这

  • Python实现处理apiDoc转swagger的方法详解

    目录 需要转换的接口 apiDoc格式 swagger格式 思路 代码 需要转换的接口 现在我需要转换的接口全是nodejs写的数据,而且均为post传输的json格式接口 apiDoc格式 apiDoc代码中的格式如下: /** * @api {方法} 路径 标题 * @apiGroup Group * @apiDescription 描述这个API的信息 * * @apiParam {String} userName 用户名 * @apiParamExample {json} request

  • Python实现登录接口的示例代码

    Python实现登录接口的示例代码

    之前写了Python实现登录接口的示例代码,最近需要回顾,就顺便发到随笔上了 要求: 1.输入用户名和密码 2.认证成功,显示欢迎信息 3.用户名3次输入错误后,退出程序 4.密码3次输入错误后,锁定用户名 Readme: 1.UserList.txt 是存放用户名和密码的文件,格式为:username: password,每行存放一条用户信息 2.LockList.txt 是存放已被锁定用户名的文件,默认为空 3.用户输入用户名,程序首先查询锁定名单 LockList.txt,如果用户名在里面

  • python实现微信接口(itchat)详细介绍

    前言 itchat是一个开源的微信个人号接口,使用python调用微信从未如此简单.使用不到三十行的代码,你就可以完成一个能够处理所有信息的微信机器人.当然,该api的使用远不止一个机器人,更多的功能等着你来发现,比如这些.该接口与公众号接口itchatmp共享类似的操作方式,学习一次掌握两个工具.如今微信已经成为了个人社交的很大一部分,希望这个项目能够帮助你扩展你的个人的微信号.方便自己的生活. 安装 sudo pip install itchat 登录 itchat.auto_login()

  • Python编写登陆接口的方法

    Python编写登陆接口的方法

    本文实例为大家分享了Python编写登陆接口的具体代码,供大家参考,具体内容如下 1.输入用户名密码: 2.认证成功后显示欢迎信息: 3.错误三次后,账号被锁定. 账号文件:user.txt 锁定文件:locked.txt 流程图如下: # -*- coding:utf-8 -*- # Author Caoxl import sys account_file='E:\user.txt' locked_file='E:\locked.txt' def deny_account(username):

  • Python tornado队列示例-一个并发web爬虫代码分享

    Queue Tornado的tornado.queue模块为基于协程的应用程序实现了一个异步生产者/消费者模式的队列.这与python标准库为多线程环境实现的queue模块类似. 一个协程执行到yieldqueue.get会暂停,直到队列中有条目.如果queue有上限,一个协程执行yieldqueue.put将会暂停,直到队列中有空闲的位置. 在一个queue内部维护了一个未完成任务的引用计数,每调用一次put操作便会增加引用计数,而调用task_done操作将会减少引用计数. 下面是一个简单的

随机推荐