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 或 Rider 打开解决方案文件 Admin.NET.sln
3. 修改 appsettings.json 中的数据库连接字符串
4. 运行项目，系统将自动创建数据库并初始化种子数据

1.3 前端安装

1. 进入前端目录：

   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. 系统监控：查看服务器状态和在线用户
7. 任务调度：配置定时任务

2.3 开发建议

• 建议为每个应用系统单独创建工程（参考 Admin.NET.Application 层）
• 通过引用 Admin.NET.Core 层复用核心功能
• 避免直接修改框架核心代码，可通过扩展方式实现定制需求

3. 项目API使用文档

3.1 基础API规范

• 采用 RESTful 风格设计
• 统一返回格式：

  {
    "code": 200,
    "message": "操作成功",
    "data": {}
  }
  

3.2 认证授权

• 使用 JWT 认证
• 请求头需携带：

  Authorization: Bearer {token}
  

3.3 常用API示例

用户登录

POST /api/auth/login
Content-Type: application/json

{
  "account": "superadmin",
  "password": "Admin.NET++010101"
}

获取用户信息

GET /api/system/user/info
Authorization: Bearer {token}

分页查询用户列表

GET /api/system/user/page?pageNo=1&pageSize=10
Authorization: Bearer {token}

3.4 Swagger文档

• 访问 /swagger 查看完整API文档
• 支持 Knife4jUI 增强界面

4. 项目安装方式

4.1 开发环境安装

1. 安装 .NET 6 SDK
2. 安装 Node.js 16+
3. 安装 pnpm：

   npm install -g pnpm
   

4. 安装数据库（如 SQL Server）

4.2 生产环境部署

后端部署

1. 发布项目：

   dotnet publish -c Release -o ./publish
   

2. 部署到 IIS 或使用 Kestrel：

   dotnet Admin.NET.Web.dll
   

前端部署

1. 构建生产版本：

   pnpm run build
   

2. 部署 dist 目录到 Nginx 或其它Web服务器

4.3 容器化部署

项目支持 Docker 部署，提供 Dockerfile 文件：

docker build -t adminnet .
docker run -d -p 5000:80 adminnet

4.4 多租户配置

在 appsettings.json 中配置多租户选项：

"TenantSettings": {
  "Enabled": true,
  "DefaultConnectionString": "Server=.;Database=AdminNET;User ID=sa;Password=123456;"
}