swagger-ui-bundle-pip包中的swagger-ui文件
swagger-ui-bundle的Python项目详细描述
招摇过市的组合
这个包包含了作为python包的swagger ui的静态文件。
基本配置选项是用jinja2模板语言模板化的。
这个包是不可知web服务器的,所以它只包括 静态文件和一些非常基本的配置。
开始
您可以从swagger ui_bundle包导入swagger ui_路径,如下所示:
fromswagger_ui_bundleimportswagger_ui_path# or if you need a specific versionfromswagger_ui_bundleimportswagger_ui_2_pathfromswagger_ui_bundleimportswagger_ui_3_path
您可以很容易地将此目录作为所有静态文件提供,以获得默认的 大摇大摆的用户界面分布。下面是烧瓶中的一个示例:
fromswagger_ui_bundleimportswagger_ui_pathfromflaskimportFlask,Blueprint,send_from_directory,render_templateswagger_bp=Blueprint('swagger_ui',__name__,static_url_path='',static_folder=swagger_ui_path,template_folder=swagger_ui_path)app=Flask(__name__,static_url_path='')app.register_blueprint(swagger_bp,url_prefix='/ui')if__name__=="__main__":app.run()
您可能希望重写某些配置变量。包括 是一个jinaj2模板文件,您可以在其中修改这些参数。 您可以添加另一个路由来使用 所需配置如下:
SWAGGER_UI_CONFIG={"openapi_spec_url":"https://petstore.swagger.io/v2/swagger.json"}@swagger_bp.route('/')defswagger_ui_index():returnrender_template('index.j2',**SWAGGER_UI_CONFIG)
查看flask webserver的完整服务器的example.py。
许可证
因为这只是重新打包的swagger ui版本,所以许可证来自 大摇大摆的ui项目(https://github.com/swagger-api/swagger-ui)。
所有提供的代码都由SmartBear软件在Apache2.0下发布 执照。