未提供项目说明

falibrar的Python项目详细描述


假图书馆

GitHub ActionsGitHubPyPI - Python VersionDocumentation Status

用于API规范和验证的Falcon插件。在

为烧瓶服务提供OpenAPI文档和验证。在

主要为机器学习模型服务。在

如果您使用的是Flask,请查看我的另一个Python库Flaskerk。在

注意

我创建了一个名为SpecTree的新库。它支持Falibrary的所有特性,但具有更好的界面。试试看!此库将来可能会存档。

特点

  • 使用Redoc UI或{a6}生成API文档:yum:
  • 更少的样板代码,注释非常容易使用:火花:
  • pydantic:wink验证查询、JSON数据、响应数据:
  • API服务更好的HTTP例外(默认和自定义)(JSON而不是HTML):恶作剧:

快速入门

使用pip install falibrary(Python 3.6+)安装

基本示例

importfalconfromwsgirefimportsimple_serverfrompydanticimportBaseModelfromfalibraryimportFalibraryapi=Falibrary(title='Demo Service',version='0.1.2',)classQuery(BaseModel):text:strclassDemo():@api.validate(query=Query)defon_post(self,req,resp):print(req.context.query)passif__name__=='__main__':app=falcon.API()app.add_route('/api/demo',Demo())api.register(app)httpd=simple_server.make_server('localhost',8000,app)httpd.serve_forever()

需要进行的更改:

  • 使用pydantic创建模型
  • Falibrary.validate()修饰route函数
  • 指定您在validate中需要的部件
    • query(url中的args)
    • data(来自请求的JSON数据)
    • resp(response)这将在验证后转换为JSON数据
    • x(HTTP异常列表)
    • tags(此路由的标记)
  • 注册Falcon应用程序

之后,这个库将帮助您验证传入的请求并在/apidoc中提供API文档。在

Parameters in ^{}Corresponding parameters in ^{}
^{}^{}
^{}^{}
^{}\
^{}\
^{}\

有关详细信息,请查看document。在

更多功能

^{pr2}$

尝试使用http POST ':8000/api/zh/en?text=hello' uid=0b01001001 limit=5 vip=true。在

打开http://127.0.0.1:8000/apidoc中的文档。在

有关更多示例,请选中examples。在

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

推荐PyPI第三方库


热门话题
java多线程秒表   java如何防止ConcurrentModificationException?   java我们如何实现组发送消息功能?   java如何从jQueryAjax调用调用SpringMVC控制器   类如何正确使用Java客户机/服务器类   java R无法解析为变量(新的安卓项目)   带有多过滤器选项的java Javafx TableView   udp Java DatagramSocket在几次运行后抛出SocketTimeoutException   swing Java GUI布局建议   java有办法在到期时重建ehcache吗   java在所有项目中运行所有测试类   使用Java HtmlEditorKit保存汉字   java螺旋菱形打印图案   变量为什么我的windows实例在我的游戏中无法识别。java类?