# 脚手架-python

**Repository Path**: gilbertwang/scaffolding-python

## Basic Information

- **Project Name**: 脚手架-python
- **Description**: python-fastapi脚手架
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-08-05
- **Last Updated**: 2025-12-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Python

## README

## Python服务端脚手架 

#### 【注】适用于FastAPI/uvicorn项目 


## 安装步骤 

#### 1.建议使用python3.8以及以上版本； 

#### 2.创建虚拟环境 

安装 python 版本大于等于 3.8


#### 3.安装依赖包 

进入项目根目录执行:
./packaging.sh

在dist文件夹中找到wheel包,源码包以及启动脚本；


#### 4.创建表

scaffolding.sql脚本文件


#### 5. 设置环境变量

###### * JWT token
JWT_KEY=

###### * REDIS相关
REDIS_HOST=

REDIS_PORT=

###### * MYSQL相关
DB_HOST=

DB_PORT=

DB_USER=

DB_PASS=

DB_NAME=

###### * AI相关
AI_API_KEY=

AI_API_URL=

AI_MODEL_TYPE=

#### 6.启动服务
执行dist目录下的run.sh脚本；

## API鉴权机制

#### 1. 先通过getToken接口获取access token和refresh token。系统先为应用分配appId和appSecret，请
应用保管好 appSecret。在发起获取token请求的时候，需要进行签名，签名算法：md5(appId-appSecret-source-timestamp)

#### 2. access token 和 refresh token 都有过期时间，一般前者的过期时间短与后者，可以使用后者进行access token续票。
在refresh token过期之前，需要提前使用getToken接口更换access/refresh token 。

#### 3. getToken接口需要接口验签以获取新的access/refresh token。而refreshToken接口只需要提供refresh token对access token进行续票。

## 网络安全

#### 1. 单IP限流；
#### 2. 服务限流；
#### 3. 防SQL注入；
#### 4. IP黑/白名单；
#### 5. 防盗链；
#### 6. UA；