Fraqv0.14.0

@fraqjs/plugin-milky-server

@fraqjs/plugin-milky-server npm version

@fraqjs/plugin-milky-server 提供了在 Fraq 上代理上游 Milky 服务的能力。

安装与配置

将插件添加到 fraq.ymlplugins 字段下:

plugins:
  # 本插件依赖 fraqjs/hono,因此需要一并安装
  fraqjs/hono:
    # 在这里传入 HonoPlugin 的配置选项
  fraqjs/milky-server:
    # Milky 协议的访问令牌,用于验证 /api 和 /event 请求的 Authorization 头
    # 默认不进行验证,请务必在生产环境中设置一个安全的访问令牌
    accessToken: 'my-secret-token'
    # 端点的路径前缀,默认为 /milky,即端点为 /milky/api/:api 和 /milky/event
    prefix: /milky

插件开发者通常情况下无需直接使用 MilkyServerPlugin

端点说明

插件注册的端点遵循 Milky 通信协议

  • POST {prefix}/api/:api:API 调用端点。请求体以 JSON 传递参数,响应格式为 { status, retcode, data | message }
  • GET {prefix}/event:事件推送端点。根据请求的 Upgrade 头自动选择 WebSocket 或 SSE 连接,连接建立后将上下文接收到的事件实时推送给客户端。

On this page