# Net6 WebApi

**Repository Path**: miro_lu/net6-web-api

## Basic Information

- **Project Name**: Net6 WebApi
- **Description**: 集成了JWT，SqlSugar，Redis等框架的完整.net 6 webapi项目。内置了很多帮助类，可以直接当作项目使用。
- **Primary Language**: C#
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 17
- **Forks**: 2
- **Created**: 2023-07-12
- **Last Updated**: 2025-03-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Net6 WebApi

#### 介绍
集成了JWT，SqlSugar，Redis等框架的完整.net 6 webapi项目。内置了很多帮助类，可以直接当作项目使用。

#### 环境配置
1. 开发工具：visual studio 2021
2. 目标框架：.NET 6.0


#### 使用说明

1. 修改appsettings.json中Development.json环境，配置数据库连接（自行加密）。
2. 在mysql中执行根目录中的【创建demo表.sql】文件，创建demo需要的表。
3. 启动项目。


#### 集成功能
1. JWT登录验证，登录过期设置（24小时过期，45分钟不操作自动过期）。
2. 集成了轻量级的ORM框架SqlSugar 5.X，具体使用请看官网说明[SqlSugar 5.X](http://https://www.donet5.com/Home/Doc)。
3. 集成了Redis的常用方法（哨兵模式连接）。
4. 继承了log4net日志组件（默认按天分组）。
5. 封装了IOC，接口或类继承Scoped,Transient,Singletion接口后 可直接在构造函数中注入。
6. 封装了常用帮助类：枚举操作，Excel读取写入，加密解密，上传文件，类型转换等。


#### 使用docker部署
1. 发布项目：项目右键发布，在发布目录中打开cmd
2. 构建项目（第一次比较慢）
```
docker build -t webapi:1.0.0 .
```
3. 运行容器（环境变量和映射宿主机文件夹可自定义）
```
docker run -dp 8088:80 -e ASPNETCORE_ENVIRONMENT=Development -v /share/files:/app/files -v /data/logs:/app/logs --name webapi --restart=always webapi:1.0.0
```


#### 目录结构
- Commons
    - Attribute 存放自定义特性
    - Helpers 存放一些帮助类
- ConfigFiles 存放配置文件
- Models 实体文件夹
    - Api 外部接口响应请求实体
    - Common 公共实体
    - Database 数据库实体
    - Enums 枚举
    - Views 内部接口请求响应实体
- Controllers 控制器文件夹
- Repository 数据库操作代码
- Services 业务逻辑代码
- appsettings.json 配置文件（公共配置）
    - appsettings.Development.json 开发配置文件
    - appsettings.Staging.json Qa测试文件
    - appsettings.Porduction.json 正式测试文件