python tornado 使用 swagger

  • 寫這個文章的主要原因,就是因爲沒有相關的東西,導致我完全不知道應該怎麼做,經過了兩個晚上的摸索,終於搞清楚了,如果有誰需要tornado+swagger的輸出模式,可以照這個套;

主要是static文件的生成

  • 我們用swagger就是爲了做一個靜態頁面,也就是生成一個static文件:

    1. 幾個必備的工具:swagger-py-codegen我們不用他們的文件框架只需要其生成的static文件,拷貝到自己文件夾下即可;
      1)需要注意的是生成文件需要用yaml文件,當編輯好文件後,最主要的是要注意base_path文件的改動,你生成的文件的請求會加上你basepath的內容,會造成請求出錯, 比如 你的url:port/GET?testparas=test,那麼如果說你的static文件生成的過程中,如下圖所示


      python tornado 使用 swagger_第1张图片
      即如圖所示

      2)生成的文件,swagger-ui中的swagger.json文件是按照你的yaml文件生成的,index.html文件中是有地方設置swagger.json的地址的,如下圖所示


      python tornado 使用 swagger_第2张图片
      這裏寫圖片描述

      3)這個時候我們可以啓動我們的swagger程序,


      python tornado 使用 swagger_第3张图片
      這裏寫圖片描述

接下來接受一下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()`
  • 目錄結構如下


    python tornado 使用 swagger_第4张图片
    這裏寫圖片描述
  • 生成swagger-ui的代碼如下:

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

其中 –ui –spec是生成swagger-ui的關鍵代碼

原文链接

https://www.twblogs.net/a/5b81ff7f2b71772165af1e5b

你可能感兴趣的:(python tornado 使用 swagger)