Admin.NET 通用权限开发框架技术文档

1. 安装指南

1.1 环境要求

• 操作系统：Windows/Linux/麒麟操作系统
• 运行时环境：.NET 6 SDK
• 数据库：支持多种数据库（SQL Server/MySQL/PostgreSQL/Oracle等）
• 前端环境：Node.js 16+，pnpm

1.2 后端安装

1. 克隆项目仓库：

   git clone https://gitee.com/zuohuaijun/Admin.NET.git
   

2. 使用Visual Studio 2022或Rider打开解决方案
3. 修改appsettings.json中的数据库连接字符串
4. 运行项目，系统将自动创建数据库并初始化种子数据

1.3 前端安装

1. 进入Web目录：

   cd Web
   

2. 安装依赖：

   pnpm install
   

3. 运行开发服务器：

   pnpm run dev
   

4. 生产环境构建：

   pnpm run build
   

2. 项目使用说明

2.1 系统登录

• 默认管理员账号：superadmin
• 默认密码：Admin.NET++010101
• 首次登录后建议立即修改密码

2.2 核心功能模块

1. 用户管理：可创建/编辑用户，分配角色和组织机构
2. 角色管理：定义角色并分配菜单权限和数据权限
3. 菜单管理：配置系统菜单结构和按钮权限
4. 组织机构：维护公司组织架构树形结构
5. 系统监控：查看服务器状态、在线用户和系统日志
6. 代码生成：一键生成前后端代码，加速开发

2.3 开发建议

• 新建应用系统时，建议创建独立的Admin.NET.Application层
• 核心业务逻辑应放在应用层中实现
• 通过依赖注入方式调用框架提供的服务

3. 项目API使用文档

3.1 基础API结构

所有API遵循RESTful规范，使用JWT进行认证

3.2 认证授权

• 登录接口：POST /api/auth/login
• 请求头需携带：Authorization: Bearer {token}

3.3 常用API示例

1. 获取当前用户信息：

   GET /api/system/user/info
   

2. 分页查询用户列表：

   GET /api/system/user/page?pageNo=1&pageSize=10
   

3. 创建新用户：

   POST /api/system/user/add
   Content-Type: application/json
   
   {
     "account": "testuser",
     "password": "123456",
     "name": "测试用户"
   }
   

3.4 Swagger文档

项目集成Swagger，访问/swagger可查看完整API文档

4. 项目安装方式

4.1 Docker部署

1. 构建镜像：

   docker build -t adminnet .
   

2. 运行容器：

   docker run -d -p 5000:80 --name adminnet_container adminnet
   

4.2 传统部署

1. 发布后端项目：

   dotnet publish -c Release -o ./publish
   

2. 将publish目录内容部署到服务器
3. 配置Nginx反向代理

4.3 数据库配置

支持多种数据库，修改appsettings.json中的连接字符串：

"ConnectionStrings": {
  "DefaultConnection": "Server=.;Database=AdminNET;User ID=sa;Password=123456;"
}

4.4 国产化适配

• 支持达梦、人大金仓等国产数据库
• 集成国密算法(SM2/SM3/SM4)
• 适配麒麟操作系统