# project-structure-template

**Repository Path**: software-engineering-pre-project/project-structure-template

## Basic Information

- **Project Name**: project-structure-template
- **Description**: 介绍项目结构规范
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-01
- **Last Updated**: 2025-12-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

1.确保有.gitignore(常规的__pycache__，data，models都是要忽略的)（特别是有模型的要注意，要忽略，gitee如果提交太大就提交不了，但是你们本地又已经提交了模型，这个时候就要删除仓库的一条历史记录，记住这个不是回溯，而是删除，很麻烦要下载一个软件啥的，因为回溯了后历史记录还是会有）  
2.确保有openapi.json（并且移到根目录），还有generate_openapi.py也是移到根目录（这个文件里面生成的openapi.json目录就是运行程序的目录也就是根目录），每次项目更新都要生成  
3.api，core目录的是所有人都有的  
4.文档一定要及时更新  
5.一些奇怪的文件夹都要删除，比如wc的XTT，还有你们项目的LICENSE，还有YWX的.42c是什么鬼。  
6.每个结构的request和respond都要用basesmodle包装放到api/models，并且写好注释，如图  
![alt text](doc/image2.png)  
7.api/model文件夹里面对应api/routes里面的每个程序创建对应的model，如下  
![alt text](doc/image.png)