5 Star 32 Fork 4

网安科技前端组 / restfx

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

restfx

Python3 的 RESTful 服务框架。

底层基于 werkzeug

为什么要使用此框架

开发此框架的目标是 提升开发效率

此框架解决了以下问题:

  • 没有繁锁的路由配置,免去路由注册。仅仅需要对模块根进行注册,模块下的所有路由都会自动被收集调用
  • 不需要对路由 url 进行显示配置,完全自动解析
  • 自动解析/校验请求参数,并填充到路由函数,省去繁锁的参数获取/类型校验。需要做的仅仅是编写一个函数,并添加函数参数的类型声明
  • 提供 接口列表页面 以及接口测试支持,让接口随码更新,不用手动维护API文档。 见截图
  • 提供 路由注入 支持,以通过参数方式向路由指定请求参数外的数据/函数,从而避免一些频繁的 import 和重复代码

此框架的弊端: 不支持将参数作为 url 路径的一部分

安装

pip install restfx

Since 0.7.1 安装后,可以通过 CLI 工具 restfx 命令创建基本项目结构:

restfx create projectname

使用此命令,可能需要将 restfx 安装到全局环境中。

文档

使用文档见 Gitee Wiki

创建应用

import os

import restfx

if __name__ == '__main__':
    root = os.path.dirname(__file__)
    app = restfx.App(root, api_prefix='any/prefix', debug=True)
    app.map_routes({
        'x': 'test'
    })
    app.map_static(static_map={})
    app.startup(host='127.0.0.1', port=9127)

编写路由

test/api/demo.py

from restfx import route
from restfx.http import HttpRequest, HttpFile


@route(module='测试名称-模块', name='测试名称-GET')
def get(request, param1, param2=None, param3: int = 5):
    # request 会是 HttpRequest
    return {
        'param1': param1,
        'param2': param2,
        'param3': param3,
    }


@route(module='测试名称-模块', name='测试名称-POST_PARAM')
def get_param(param1, req: HttpRequest, from_=None, param3=5):
    # req 会是 HttpRequest
    return {
        'param1': param1,
        'from': from_,
        'param3': param3,
    }


@route(module='测试名称-模块', name='测试名称-PUT_PARAM')
def put(request: str, param1, file: HttpFile, param3=5):
    # request 会是请求参数,参数列表中没有 HttpRequest
    return {
        'request': request,
        'param1': param1,
        'param3': param3,
    }


@route(module='测试名称-模块', name='测试名称-DELETE_PARAM')
def delete(request, param1, from_=None, param3=5, **kwargs):
    # 未在函数的参数列表中声明的请求参数,会出现在 kwargs 中
    return {
        'param1': param1,
        'from': from_,
        'param3': param3,
        'variable_args': kwargs
    }

截图

以下截图为接口列表,对应的路由声明源码见

以下截图仅在 Gitee仓库目录 可见

list

test

The MIT License (MIT) Copyright (c) 2020 hyjiacan Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

Python3 的 RESTful 服务框架 展开 收起
MIT
取消

发行版 (24)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
Python
1
https://gitee.com/wangankeji-fe/restfx.git
git@gitee.com:wangankeji-fe/restfx.git
wangankeji-fe
restfx
restfx
master

搜索帮助