restfx适用于 Python 3 的 restful 多应用自动路由框架
restfx 是一个适用于 Python3 的 restful 自动路由框架。
此框架解决的问题:
- 没有繁锁的路由配置
- 便捷的 restful 编码体验
- 自动解析/校验请求参数,并填充到路由处理函数
安装
- Gitee: https://gitee.com/hyjiacan/restfx
- Github: https://github.com/hyjiacan/restfx
- PyPI: https://pypi.org/project/restfx/
pip install restfx
安装后,可以通过 CLI 工具 (0.7.1
) restfx
命令创建基本项目结构:
restfx create projectname
使用此命令,可能需要将
restfx
安装到全局环境中。
创建应用
import os import restfx if __name__ == '__main__': root = os.path.dirname(__file__) app = restfx.App(root, api_prefix='any/prefix', debug_mode=True) app.map_routes({ 'x': 'test' }).map_static(static_map={}).startup(host='127.0.0.1', port=9127, **kwargs)
-
api_prefix
用于指定 api 接口 url 的根路径,即所有接口都是以此项指定的值开始(默认值为api
)。 -
map_static
用于指定静态资源与目录映射关系。import os static_map = { '/static': os.path.join(root, 'path/to/static') }
/static
访问静态目录{root}/path/to/static
。 指定的静态目录可以是绝对路径,也可以是相对root
的相对路径。
wsgi
App
实例本身即是 wsgi
入口。
main.py
from restfx import App
# app 就是 wsgi 入口
app = App(...)
在部署到 wsgi 容器时,将 main:app
暴露给容器作为入口。
截图
路由声明
API列表
评论