@dynamicforms/fastapi-viewsets

中文文档
0.15.4发布于 2026/11/13MITTypeScriptES Module零依赖近 30 天下载 2833

Vue 的 REST 视图

中文使用文档
文档目录4 节
  1. 安装
  2. 快速实例
  3. 演示
  4. 许可证

动态格式 FastAPI 视图

贾戈雷斯特 框架样式视图 FastAPI 软件,可选 Celery支持的ASync执行和匹配的Vue/TypeScript客户端对应.

  • FastAPI 的 Python 混音器 ——由CRUD和散装端点组成从小型,有重点的混音类.
  • route_viewset 装饰 ——在FastAPI路由器上注册一个取景器,并使用单一的装饰器呼叫. 自动处理类型分辨率,生命周期管理和OpenAPI schema.
  • 嵌入式视图 ——在他人的路径下挂起一个取景器(/accounts/members与 ViewSetRouter.sub_viewset;要求通过父母的支票和自己的支票.
  • CollectionViewSet ——由任何 Python 列表,设置或 dict 支持的 0-boilerpate in-memory 视图集. 对原型和测试都有好处.
  • DjangoORMViewSet ——背以一出"强哥"取景. 它可以编译的过滤器 排序顺序,其 NULL 位置,页面为 LIMIT/OFFSET,总计为 COUNT(*) 全部 变成"SQL";一个会下降的阶段会回落到记忆中,而不是失败 pk_field_name 来源于模型的主键(需要 django (第2条).
  • celery_viewset 装饰 ——将一个取景器的处决移到一个没有代码变化的 Celery 工人身上 对于长期或背景处理情景(要求 celery (第2条).
  • 散装作业 ——一等支持批量创建,更新,部分更新和销毁.
  • 木蜡运输 ——通过一个WebSocket而不是一个HTTP请求访问相同的视图 每个呼叫。 命令会通过您的应用程序, 如 HTTP 请求做 - 它的中间软件, 例外处理器、路由器依赖性和状态 - 所以两种运输方式都是一样的.
  • 活动 - 发表一个主题的活动 和每一个前端 得知它,作为一个muxws 推动或者在它的下一次民意调查. ChangeEvents 发布每个视图的创建、更新和销毁 它的路由基准路径; 自定义事件以 source()。每个事件都记录在它面前 推来推去,所以推来推去的代价是暂时的,而不是一个事件。 在前门, watch() 视图集 一、导 言 applyChanges() 将每个修改应用到行列表.
  • 三个列表形状 光线阵列、相向拨号或光标拨号。 一个景区宣布, 并可能让客户端以 X-List-Shape 头曰.
  • 声明过滤器 ——声明哪些字段接受哪些操作符并获得查询参数, 免费的 OpenAPI 计划并过滤; 后端将其所能翻译成自己的查询 .
  • Vue / 类型脚本对应 - 镜像混合类和 restViewSet 编号 : muxwsViewSet 类 厂家会给您一个完全输入的客户端, 与您的后端视图集完全匹配: 混音器是一个 ViewSet 声明是其公开的表面,所以称它没有宣布的动作是编译错误 运行时间 404(单独公布为 @dynamicforms/fastapi-viewsets 在npm上。 .

安装

pip install dynamicforms-fastapi-viewsets

# with Celery-backed viewset support
pip install "dynamicforms-fastapi-viewsets[celery]"

# with the muxws WebSocket transport
pip install "dynamicforms-fastapi-viewsets[muxws]"

# with the Django ORM backend (Django 4.2+ and asgiref)
pip install "dynamicforms-fastapi-viewsets[django]"

需要Python 3.10+,FastAPI和Pydantic 2.11+.

快速实例

from fastapi import APIRouter, FastAPI
from pydantic import BaseModel

from fastapi_viewsets.collection_viewset import CollectionViewSet
from fastapi_viewsets.decorators.route_viewset import route_viewset
from fastapi_viewsets.mixins import BulkViewSetMixin


class Item(BaseModel):
    id: int
    name: str


database: dict[int, Item] = {1: Item(id=1, name="First element")}

app = FastAPI()
router = APIRouter()


@route_viewset(router, base_path="/items", pk_field_name="id")
class ItemViewSet(CollectionViewSet[int, Item], BulkViewSetMixin[int, Item]):
    def __init__(self):
        super().__init__(container=database, pk_field="id")


app.include_router(router)

见 完整文档 指南 混合系统, route_viewset, (中文(简体) ), CollectionViewSet, (中文(简体) ), DjangoORMViewSet, (中文(简体) ), celery_viewset,则 列出管道和页码、muxws运输、事件和Vue客户端.

演示

uv sync && npm ci
uv run python demo.py                # backend on :8000, frontend on :5173
uv run python demo.py --celery       # ... with every viewset call routed through a Celery worker
npm run test:e2e                     # drives the demo in a browser

一个无限的滚动网格 超过一个5000个轨道库,光标页. 切换整个网格之间 rEST和MUXWs运输 以及内线和SQLite后端之间 并比较它们 长相并相. 排序和过滤是服务器侧.

网格跟随它的取景器变化事件(ChangeEvents 在后端, watch() 输入 (原始内容存档于2017-09-21). Greet. 单击一个最喜爱的单元格来切换它:每个显示库的标签都应用更改,结束 作为推手,在下一场民意测验中超越REST。 排序或过滤的网格重装其列表 更改:行可能已经移动或离开.

--celery 需要Redis在本地主机: 6379。 工人们用后端和 通过Redis来公布他们的事件. 它作为一个过程运行,因为内存库是一个 dict由每个进程所持有;SQLite库是每个进程共享的一个文件. 端对端 套件在自己的端口启动自己的后端和dev服务器.

许可证

麻省理工学院——见 自由主义。 。 。 .

版本与发布记录

@dynamicforms/fastapi-viewsets 共发布 42 个版本,首次发布于 2026/07/10;过去 12 个月发布了 42 个版本。

版本发布日期距今
0.15.4latest2026/11/13今天
0.15.32026/11/13今天
0.15.22026/11/13今天
0.15.12026/11/13今天
0.15.02026/11/121 天前
0.14.22026/10/2816 天前

关于 @dynamicforms/fastapi-viewsets 的常见问题

@dynamicforms/fastapi-viewsets 是什么?

Vue 的 REST 视图

如何安装 @dynamicforms/fastapi-viewsets?

在项目目录运行 npm install @dynamicforms/fastapi-viewsets,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:axios(^1.13.6)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@dynamicforms/fastapi-viewsets 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@dynamicforms/fastapi-viewsets 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@dynamicforms/fastapi-viewsets 可以商用吗?

@dynamicforms/fastapi-viewsets 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@dynamicforms/fastapi-viewsets 的下载量有多少?

根据 npm 官方下载统计,@dynamicforms/fastapi-viewsets 在 2026/10/13 – 2026/11/11 这 30 天内被下载 2,833 次,日均约 94 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@dynamicforms/fastapi-viewsets 还在维护吗?

最新版本 0.15.4 发布于 2026/11/13(今天);至今共发布 42 个版本,其中过去 12 个月发布了 42 个;首次发布于 2026/07/10。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。