Skip to content

Latest commit

 

History

History
156 lines (109 loc) · 3.91 KB

README.md

File metadata and controls

156 lines (109 loc) · 3.91 KB
Raw

雷索纳斯市场 / resonance-market

resonance-market CI

API 接口

单次上传

在 https://resonance.breadio.wiki/api/log 这一 endpoint 上, 接受 POST 请求，请求体为 JSON 格式的对象, 包含以下字段:

{
  "name": ProductName,
  "sourceCity": CityName,
  "targetCity": CityName,
  "type": "buy" | "sell",
  "trend": "up" | "same" | "down",
  "price": number,
  "percent": number,
  "uploadedAt": number
}

其中 ProductName 为商品名称, CityName 为城市名称, 可在 全商品表格 中查看

price 为价格(整数), percent 为价格显示百分比(例如 112, 而非 1.2), uploadedAt 为上传 UNIX 时间戳, 单位为毫秒

以下为一个示例

{
  "name": "防弹背心",
  "percent": 110,
  "price": 3225,
  "sourceCity": "铁盟哨站",
  "targetCity": "修格里城",
  "trend": "up",
  "type": "sell",
  "uploadedAt": 1710595468922
}

响应

预期响应为 200 OK, 响应体为

{
  "count": 1
}

批量上报

在 https://resonance.breadio.wiki/api/logs 这一 endpoint 上, 接受 POST 请求，请求体为 JSON 格式的列表, 列表中每一个对象与单次上传的格式相同:

[
  {
    "name": ProductName,
    "sourceCity": CityName,
    "targetCity": CityName,
    "type": "buy" | "sell",
    "trend": "up" | "same" | "down",
    "price": number,
    "percent": number,
    "uploadedAt": number
  },
  // ...
]

各字段含义与单次上传相同

响应

预期响应为 200 OK, 响应体为

{
  "count": number
}

其中 count 为成功上传的数据条数

本地运行 或 开发测试 / Run locally or Development Test

请确保已安装 git 和 pnpm。

Please make sure git and pnpm are installed.

  1. 对本项目进行 git clone;

    Perform git clone on this project;

    git clone https://github.com/yjl9903/resonance-market.git
cd resonance-market

  2. 使用 pnpm 安装依赖;

    Use pnpm to install dependencies;

    pnpm install

  3. 准备开发用的 SQLite 本地数据库（位于：./sqlite.db）;

    Prepare development SQLite database;

    pnpm db:prepare:dev

  4. 运行开发服务器;

    Run the development server;

    pnpm run dev

会在 http://localhost:3000 启动开发测试。

Start the development server on http://localhost:3000.

构建 / Build

本程序是一个 Nuxt 3 应用程序。所以，需自行部署者，可参考 Nuxt 的部署指南。总而言之，本程序支持借助 Node.js 在服务器上运行，也可以托管到主流的 Serverless 型的网站托管服务。我们自己选择了后者，可以参考 /.github 的相关 GitHub Actions 流程文件。

This program is a Nuxt 3 application. Therefore, those who need to deploy by themselves can refer to Nuxt's deployment guide. All in all, this program supports running on the server with Node.js, and can also be hosted on mainstream Serverless website hosting services. We chose the latter ourselves, you can refer to the related GitHub Actions process files in /.github.

# 构建生产用程序 / Build the application for production
pnpm run build
# 对生产构建进行预览 / Locally preview production build
pnpm run preview

使用协议 / License

LICENSE

本程序附带 MIT License 开源。使用本程序及其源代码时，请遵守 MIT License。

This program comes with the MIT License.