Falcon的Swagger UI应用程序

falcon-swagger-ui的Python项目详细描述


简单的Falcon应用程序,用于向Falcon添加Swagger UI 申请

包含的Swagger UI版本:v3.10.0

安装

pip install falcon-swagger-ui

用法

示例应用程序:

importfalconfromfalcon_swagger_uiimportregister_swaggerui_appapp=falcon.API()SWAGGERUI_URL='/swagger'# without trailing slashSCHEMA_URL='http://petstore.swagger.io/v2/swagger.json'### For developer environment you can expose a static endpoint like:# import pathlib## SCHEMA_URL = '/static/v1/swagger.json'# STATIC_PATH = pathlib.Path(__file__).parent / 'static'## @see: http://falcon.readthedocs.io/en/stable/api/api.html#falcon.API.add_static_route# app.add_static_route('/static', str(STATIC_PATH))#page_title='Falcon Swagger Doc'favicon_url='https://falconframework.org/favicon-32x32.png'register_swaggerui_app(app,SWAGGERUI_URL,SCHEMA_URL,page_title=page_title,favicon_url=favicon_url,config={'supportedSubmitMethods':['get'],})

运行示例应用程序:

pip install falcon gunicorn jinja2
gunicorn example:app

配置

应用程序支持重载所有的swagger ui配置 可以序列化JSON的选项见 https://github.com/swagger-api/swagger-ui#parameters用于选项。

另外,一些oauth字段暴露于特殊变量 将被呈现到相关函数中。

下面列出了应用程序默认值(应与swaggerui默认值匹配)。

{# OAuth related'app_name':'null','client_realm':'null','client_id':'null','client_secret':'null',# SwaggerUI base configuration, see https://github.com/swagger-api/swagger-ui#parameters'docExpansion':"none",'jsonEditor':False,'defaultModelRendering':'schema','showRequestHeaders':False,'supportedSubmitMethods':['get','post','put','delete','patch']}

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java如何在IntelliJ社区版中为maven项目创建war文件?   架构在java编程中创建模型数据的最佳方式   java代码可以打印当前数字右边的最大数字,最后一个数字应该打印1   java上一个和下一个按钮,用于在WebView中从数组中加载字符串   java与直接DB调用/RESTful服务调用相比,测试Hazelcast数据检索速度的最佳方法是什么?   资源/类链接上的Java404   java如何安装play2War插件(Play Framework 2.1.1.)   多线程守护进程线程行为java   java如何从RepainManager生成异常   java Hibernate集合映射问题。无法删除或更新父行:外键约束失败   java LibGDX TextureRegion NullPointerException   java无法在JUnit套件中添加测试类   java通配符捕获/泛型   awt如何在Java中获取当前的鼠标指针类型?   java将probuf转换为POJO   java bouncycastle是否支持RSA PKCS1OAEP填充?   SQLiteDatabase的java问题。SQLITE数据库时的查询()。rawQuery()工作正常   java Android。如何正确存储数据库的数据?   java如何访问与GAE默认服务帐户关联的电子邮件地址?