Home Verkennen Help
Registreren Inloggen
wuyi
/
tweb-api
1
0
Vork 0
Bestanden Issues 0 Pull-aanvragen 0 Wiki

Geen omschrijving

Boom: ee635b6f99
Aftakkingen Labels
tweb-api
ZIP TAR.GZ
wui ee635b6f99 更新package.json中的项目名称，调整启动脚本和开发脚本，修改tsconfig.json中的模块解析方式，优化app.ts中的导入路径。 6 maanden geleden
.vscode 2db384c16b init 7 maanden geleden
src ee635b6f99 更新package.json中的项目名称，调整启动脚本和开发脚本，修改tsconfig.json中的模块解析方式，优化app.ts中的导入路径。 6 maanden geleden
.env f54450b3d5 添加文件上传功能，包括ZIP、图片和文档的上传，更新环境配置以支持OSS，新增文件服务和控制器，修改路由以集成新功能。 7 maanden geleden
.env.example 2db384c16b init 7 maanden geleden
.env.production 4fcba9dbe6 . 6 maanden geleden
.gitignore 2db384c16b init 7 maanden geleden
.prettierrc.json 2db384c16b init 7 maanden geleden
README.md 2db384c16b init 7 maanden geleden
deploy.sh 9b44b58e8f . 6 maanden geleden
package-lock.json f54450b3d5 添加文件上传功能，包括ZIP、图片和文档的上传，更新环境配置以支持OSS，新增文件服务和控制器，修改路由以集成新功能。 7 maanden geleden
package.json ee635b6f99 更新package.json中的项目名称，调整启动脚本和开发脚本，修改tsconfig.json中的模块解析方式，优化app.ts中的导入路径。 6 maanden geleden
tsconfig.json ee635b6f99 更新package.json中的项目名称，调整启动脚本和开发脚本，修改tsconfig.json中的模块解析方式，优化app.ts中的导入路径。 6 maanden geleden
yarn.lock 269048d6c8 更新生产环境配置，修改端口号、数据库名称及密码，新增OSS相关配置；删除不再使用的生成钱包脚本，更新依赖版本以保持一致性。 6 maanden geleden

README.md

Robin API

一个基于 Fastify 和 TypeORM 的个人记账 API。

功能特性

  • 用户认证（注册/登录）
  • JWT 认证
  • 钱包管理
  • 收支记录管理
  • Swagger API 文档

技术栈

  • Fastify
  • TypeORM
  • MySQL
  • TypeScript
  • JWT

开始使用

环境要求

  • Node.js >= 16
  • MySQL >= 8.0
  • Yarn

安装

  1. 克隆项目

    git clone https://github.com/yourusername/robin-api.git
cd robin-api

  2. 安装依赖

    yarn install

  3. 配置环境变量

复制 .env.example 文件为 .env，并根据你的环境修改配置：

cp .env.example .env

  1. 创建数据库

    CREATE DATABASE robin_db;

  2. 运行开发服务器

    yarn dev

API 文档

启动服务器后，访问 http://localhost:3000/documentation 查看 Swagger API 文档。

API 端点

用户

  • POST /api/users/register - 用户注册
  • POST /api/users/login - 用户登录

钱包

  • POST /api/wallets - 创建钱包
  • GET /api/wallets - 获取所有钱包
  • GET /api/wallets/:id - 获取单个钱包
  • PUT /api/wallets/:id - 更新钱包
  • DELETE /api/wallets/:id - 删除钱包

记录

  • POST /api/records - 创建记录
  • GET /api/records - 获取所有记录
  • GET /api/records/:id - 获取单个记录
  • PUT /api/records/:id - 更新记录
  • DELETE /api/records/:id - 删除记录

许可证

MIT