快速上手

简介

本 SDK 提供了简单高效的方式与 GMSSH 服务进行通信，基于 JSON-RPC 2.0 协议，通过 Unix Socket 文件实现高性能数据交换。

核心特性

基于 Unix Socket 的高性能通信
遵循 JSON-RPC 2.0 标准协议
支持 Python 3.10+ 异步编程
简单易用的 API 设计

平台兼容性

本 SDK 基于 Unix Socket 通信，仅支持 Linux 和 macOS 系统，不支持 Windows 系统。

环境准备

Python 环境要求

版本要求

当前 SDK 仅支持 Python 3.10 及以上版本

安装 Python 3.10+

访问 Python 官网下载并安装适用于您操作系统的 Python 版本。

验证安装

python3 --version
# 输出示例: Python 3.10.0

安装 SDK

使用 pip 安装最新版本的 SDK：

pip3 install simplejrpc

验证安装：

python3 -c "import simplejrpc; print('SDK 安装成功!')"

快速开始

创建最小应用

创建一个名为 main.py 的文件：

# main.py
import asyncio
from simplejrpc.app import ServerApplication
from simplejrpc.response import jsonify

# 创建应用实例，指定 socket 文件路径
app = ServerApplication("app.socket")

@app.route(name="echo")
async def echo(message: str,lang: str):
    """带验证的回声接口"""
    return jsonify(data=f"收到消息: {message}", msg="消息已处理")

@app.route(name="hello")
async def hello():
    """简单的问候接口"""
    return jsonify(data="Hello, GMSSH!", msg="请求成功")

if __name__ == "__main__":
    asyncio.run(app.run())