# data-generate-api

**Repository Path**: whuper/data-generate-api

## Basic Information

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

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-09-25
- **Last Updated**: 2025-05-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


## 创建虚拟环境

python -m venv fapivenv

pip freeze > requirements.txt

pip install -r requirements.txt


## 激活虚拟环境

fapivenv\Scripts\activate.bat

## 运行 FastAPI 应用

在激活的虚拟环境中，使用 ` uvicorn main:app --reload `

其中main是Python文件的名称（不包含.py扩展名），app是FastAPI实例的名称。

--reload参数表示在代码发生变化时**自动重新**加载应用。


```
uvicorn app.main:app --reload

```

## api文档

### SwaggerUi风格

http://127.0.0.1:8000/docs

### ReDoc风格文档

http://127.0.0.1:8000/redoc


### 访问OpenAPI

FastAPI框架内部实现了OpenAPI 规范，通过访问 http://127.0.0.1:8000/openapi.json

我们可以看到整个项目的 API对应的JSON描述信息

> https://www.jianshu.com/p/299a56eeec46

> https://zhuanlan.zhihu.com/p/706632683