# RuoVea.OmiApi

**Repository Path**: starry123/ruovea-omi-api

## Basic Information

- **Project Name**: RuoVea.OmiApi
- **Description**: System 接口管理组件
用户、角色、菜单、机构、职位、权限管理 API
- **Primary Language**: C#
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2024-10-31
- **Last Updated**: 2026-03-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# RuoVea.OmiApi

## 📋 项目介绍

RuoVea.OmiApi 是一套功能强大的扩展接口类库，为.NET项目提供了丰富的开箱即用的API模块，简化开发流程，提高开发效率。

## ✨ 项目特点

- **模块化设计**：采用模块化架构，各功能模块独立封装，可按需引入
- **开箱即用**：提供完整的API接口，无需重复开发基础功能
- **高度可扩展**：基于.NET Core的依赖注入设计，易于扩展和定制
- **多版本支持**：支持.NET 6.0、7.0、8.0、9.0、10.0等多个版本
- **标准化接口**：统一的API设计风格，易于集成和使用
- **完善的文档**：提供详细的使用文档和示例

## 🚀 核心模块

### 1. [**RuoVea.OmiApi.Auth**](/RuoVea.OmiApi.Auth/README.md ':include:type=md')
- 用户登录认证API
- 支持多种登录方式
- 集成JWT token验证
- 提供验证码服务

### 2. [**RuoVea.OmiApi.Config**](/RuoVea.OmiApi.Config/README.md ':include:type=md')
- 系统参数配置接口
- 支持动态配置管理
- 配置缓存机制
- 多环境配置支持

### 3. [**RuoVea.OmiApi.Dict**](/RuoVea.OmiApi.Dict/README.md ':include:type=md')
- 字典管理API
- 支持字典类型和字典值的CRUD操作
- 字典缓存机制
- 多语言支持

### 4. [**RuoVea.OmiApi.Log**](/RuoVea.OmiApi.Log/README.md ':include:type=md')
- 日志管理API
- 支持操作日志、异常日志、访问日志
- 日志查询和分析
- 日志存储和清理策略

### 5. [**RuoVea.OmiApi.User**](/RuoVea.OmiApi.User/README.md ':include:type=md')
- 用户管理API
- 支持用户的CRUD操作
- 用户信息查询和更新
- 用户状态管理

### 6. [**RuoVea.OmiApi.UserRole**](/RuoVea.OmiApi.UserRole/README.md ':include:type=md')
- 用户角色管理API
- 支持角色的CRUD操作
- 用户与角色的关联管理
- 角色权限管理

### 7. [**RuoVea.OmiApi.UserRoleMenu**](/RuoVea.OmiApi.UserRoleMenu/README.md ':include:type=md')
- 用户、角色、菜单关联API
- 支持菜单的CRUD操作
- 角色与菜单的权限分配
- 用户菜单权限控制

### 8. [**RuoVea.OmiApi.SystemApp**](/RuoVea.OmiApi.SystemApp/README.md ':include:type=md')
- 完整的系统管理API
- 包含用户、角色、菜单、机构、职位、权限管理
- 支持多级机构管理
- 完善的权限控制体系

### 9. [**RuoVea.OmiApi.Article**](/RuoVea.OmiApi.Article/README.md ':include:type=md')
- 文章管理API
- 支持文章的CRUD操作
- 文章分类和标签管理
- 文章评论和点赞功能

### 10. [**RuoVea.OmiApi.Ledger**](/RuoVea.OmiApi.Ledger/README.md ':include:type=md')
- 记账管理API
- 支持账单的CRUD操作
- 收支分析和统计
- 多账本管理

### 11. [**RuoVea.OmiApi.Reports**](/RuoVea.OmiApi.Reports/README.md ':include:type=md')
- 报表管理API
- 支持自定义SQL报表
- 报表数据查询和导出
- 报表权限控制

### 12. [**RuoVea.OmiApi.Upload**](/RuoVea.OmiApi.Upload/README.md ':include:type=md')
- 文件上传API
- 支持多种文件类型
- 文件存储和管理
- 上传权限控制

## 📦 安装教程

### 通过 NuGet 安装

```powershell
# 安装核心包
PM> Install-Package RuoVea.ExApp
PM> Install-Package RuoVea.ExCache
PM> Install-Package RuoVea.ExCaptcha
PM> Install-Package RuoVea.ExConfig
PM> Install-Package RuoVea.ExCrypt
PM> Install-Package RuoVea.ExDto
PM> Install-Package RuoVea.ExEvenBus
PM> Install-Package RuoVea.ExFile
PM> Install-Package RuoVea.ExGlobal
PM> Install-Package RuoVea.ExHtml
PM> Install-Package RuoVea.ExLog
PM> Install-Package RuoVea.ExUtil
PM> Install-Package RuoVea.ExWeb

# 安装具体模块包
PM> Install-Package RuoVea.OmiApi.Auth
PM> Install-Package RuoVea.OmiApi.Config
PM> Install-Package RuoVea.OmiApi.Dict
PM> Install-Package RuoVea.OmiApi.Log
PM> Install-Package RuoVea.OmiApi.User
PM> Install-Package RuoVea.OmiApi.UserRole
PM> Install-Package RuoVea.OmiApi.UserRoleMenu
PM> Install-Package RuoVea.OmiApi.SystemApp
PM> Install-Package RuoVea.OmiApi.Article
PM> Install-Package RuoVea.OmiApi.Ledger
PM> Install-Package RuoVea.OmiApi.Reports
PM> Install-Package RuoVea.OmiApi.Upload
```

### 手动引用

1. 克隆本仓库到本地
2. 打开解决方案文件 `RuoVea.OmiApi.sln`
3. 构建项目
4. 引用生成的DLL文件

## 🛠️ 快速开始

### 1. 配置依赖注入

在 `Program.cs` 文件中添加以下代码：

```csharp
// 添加RuoVea.OmiApi服务
builder.Services.AddRuoVeaOmiApi();

// 或者单独添加某个模块
builder.Services.AddRuoVeaOmiApiAuth();
builder.Services.AddRuoVeaOmiApiConfig();
builder.Services.AddRuoVeaOmiApiDict();
// 其他模块...
```

### 2. 使用API

```csharp
// 注入服务
private readonly IAuthService _authService;

public YourController(IAuthService authService)
{
    _authService = authService;
}

// 使用API
[HttpPost("login")]
public async Task<IActionResult> Login(LoginInput input)
{
    var result = await _authService.LoginAsync(input);
    return Ok(result);
}
```

## 📁 项目结构

```
RuoVea.OmiApi/
├── RuoVea.OmiApi.Article/        # 文章模块
├── RuoVea.OmiApi.Auth/           # 认证模块
├── RuoVea.OmiApi.Config/          # 配置模块
├── RuoVea.OmiApi.Dict/            # 字典模块
├── RuoVea.OmiApi.Ledger/          # 记账模块
├── RuoVea.OmiApi.Log/             # 日志模块
├── RuoVea.OmiApi.Reports/         # 报表模块
├── RuoVea.OmiApi.SystemApp/       # 系统应用模块
├── RuoVea.OmiApi.Upload/          # 上传模块
├── RuoVea.OmiApi.User/            # 用户模块
├── RuoVea.OmiApi.UserRole/        # 用户角色模块
└── RuoVea.OmiApi.UserRoleMenu/    # 用户角色菜单模块
```

## 🎯 技术栈

- **开发框架**：.NET Core 6.0+ / .NET 7.0+ / .NET 8.0+ / .NET 9.0+ / .NET 10.0+
- **ORM框架**：SqlSugar
- **认证授权**：JWT
- **缓存**：MemoryCache / Redis
- **日志**：Log4net
- **依赖注入**：Microsoft.Extensions.DependencyInjection
- **API风格**：RESTful

## 🤝 贡献指南

1. Fork本仓库
2. 创建特性分支 (`git checkout -b feature/amazing-feature`)
3. 提交更改 (`git commit -m 'Add some amazing feature'`)
4. 推送到分支 (`git push origin feature/amazing-feature`)
5. 打开Pull Request

## 📄 许可证

本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情

## 🌟 致谢

- 感谢所有为项目做出贡献的开发者
- 感谢使用本项目的用户
- 感谢开源社区的支持

## 📞 联系方式

- **项目地址**：https://gitee.com/starry123/ruovea-omi-api.git
- **作者**：Starry

---

**RuoVea.OmiApi - 让开发更简单！** 🚀