首页
/ FastAPI Websocket RPC 项目教程

FastAPI Websocket RPC 项目教程

2024-08-26 18:28:03作者:胡唯隽

1. 项目的目录结构及介绍

FastAPI Websocket RPC 项目的目录结构如下:

fastapi_websocket_rpc/
├── examples/
│   ├── basic_example.py
│   ├── proxy_example.py
│   └── ...
├── fastapi_websocket_rpc/
│   ├── __init__.py
│   ├── client.py
│   ├── endpoint.py
│   ├── methods.py
│   └── ...
├── tests/
│   ├── __init__.py
│   ├── test_client.py
│   ├── test_endpoint.py
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
├── setup.py
└── ...

目录结构介绍

  • examples/: 包含项目的示例代码,如 basic_example.pyproxy_example.py
  • fastapi_websocket_rpc/: 核心代码目录,包含客户端、服务端和方法处理等模块。
    • __init__.py: 初始化文件。
    • client.py: 客户端实现。
    • endpoint.py: 服务端端点实现。
    • methods.py: 方法处理实现。
  • tests/: 测试代码目录,包含各种测试用例。
  • .gitignore: Git 忽略文件配置。
  • LICENSE: 项目许可证。
  • README.md: 项目说明文档。
  • setup.py: 项目安装配置文件。

2. 项目的启动文件介绍

项目的启动文件通常位于 examples/ 目录下,例如 basic_example.py。以下是 basic_example.py 的示例代码:

from fastapi import FastAPI
from fastapi_websocket_rpc import RpcMethodsBase, WebsocketRPCEndpoint

app = FastAPI()

# 定义服务端方法
class ConcatServer(RpcMethodsBase):
    async def concat(self, a: str = "", b: str = ""):
        return a + b

# 添加 RPC 端点
endpoint = WebsocketRPCEndpoint(ConcatServer())
endpoint.register_route(app, "/ws")

# 启动服务
if __name__ == "__main__":
    import uvicorn
    uvicorn.run(app, host="0.0.0.0", port=8000)

启动文件介绍

  • from fastapi import FastAPI: 导入 FastAPI 框架。
  • from fastapi_websocket_rpc import RpcMethodsBase, WebsocketRPCEndpoint: 导入 RPC 相关模块。
  • app = FastAPI(): 创建 FastAPI 应用实例。
  • class ConcatServer(RpcMethodsBase): 定义服务端方法类。
  • endpoint = WebsocketRPCEndpoint(ConcatServer()): 创建 RPC 端点实例。
  • endpoint.register_route(app, "/ws"): 注册路由。
  • if __name__ == "__main__":: 启动服务。

3. 项目的配置文件介绍

项目的配置文件主要是 setup.py,用于项目的安装和分发。以下是 setup.py 的示例代码:

from setuptools import setup, find_packages

setup(
    name="fastapi_websocket_rpc",
    version="0.1.26",
    packages=find_packages(),
    install_requires=[
        "fastapi",
        "websockets",
        "tenacity",
    ],
    author="Or Weis",
    author_email="or@permit.io",
    description="A fast and durable bidirectional JSON RPC channel over Websockets and FastApi",
    long_description=open("README.md").read(),
    long_description_content_type="text/markdown",
    url="https://github.com/permitio/fastapi_websocket_rpc",
    classifiers=[
        "Programming Language :: Python :: 3",
        "License :: OSI Approved :: MIT License",
        "Operating System :: OS Independent",
    ],
    python_requires='>=3.7',
)

配置文件介绍

  • name: 项目名称。
  • version: 项目版本。
  • packages: 包含的包。
  • `install_
登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
149
1.95 K
kernelkernel
deepin linux kernel
C
22
6
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
980
395
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
931
555
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
190
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
65
518
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0