# chiyou-api-main

**Repository Path**: luoming/chiyou-api-main

## Basic Information

- **Project Name**: chiyou-api-main
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-21
- **Last Updated**: 2026-03-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# chiyou-api

后端 API 服务（Express + TypeScript + Prisma），为以下端提供接口：

- 管理端（admin-web）
- 商户端（merchant-app）
- 点单小程序端（order-app）

## 技术栈

- Node.js
- Express
- TypeScript
- Prisma
- MySQL

## 快速开始

```bash
npm install
cp .env.example .env
npm run prisma:generate
npm run prisma:migrate
npm run dev
```

## 常用命令

```bash
npm run dev         # 开发启动
npm run build       # 生产构建
npm run start       # 运行构建产物
npm run lint        # 代码检查
```

## 目录结构

```txt
src/
  modules/          # 各业务路由模块
  common/           # 中间件、工具、通用能力
prisma/             # Prisma schema 与迁移
docs/               # 接口文档
```

## 文档

- [接口文档](./docs/api.md)
- [项目交接文档](./docs/handover.md)

## 主要路由前缀

- `/api/v1/common`
- `/api/v1/admin-web`
- `/api/v1/merchant-app`
- `/api/v1/order-app`

## 环境变量

请参考 `.env.example`，不要将任何真实密钥、数据库账号、令牌文件提交到仓库。

## 响应格式

```json
{
  "code": 0,
  "message": "success",
  "data": {},
  "timestamp": "2026-03-05T00:00:00.000Z",
  "requestId": "optional"
}
```