simapi-net/README.md

# YYApi 基于Asp.net Core 3/5的一个基础辅助包

![CI](https://github.com/YY-Tech/YYApi/workflows/CI/badge.svg)

### 包含了以下组件:

1. 统一的参数检测,基础认证服务
所有的控制器需要继承 YYApi.Controllers.BaseController

```C#
using Models;
using SimApi.Controllers;

namespace Controllers
{
    public class BaseController : SimApiBaseController
    {
        /// <summary>
        /// 获取登录用户信息
        /// </summary>
        protected SimApiLoginInfoItem LoginInfo => (SimApiLoginInfoItem) HttpContext.Items["LoginInfo"];
    }
}
```

2. 基于Swagger的API文档服务

```C#
#Startup.cs

	services.AddSimApiDoc("文档名称", "文档描述");

	app.UseSimApiDoc("名称",SubmitMethod[])

#控制器中可以直接使用特性

	[SimApiDoc("分组","名称")]
```

3. 简单的基于Redis的登录TOKEN服务

```C#
#Startup.cs
service.AddSimApiAuth();
```
添加时候, 可以从DI中获取 Auth 类,调用 Auth.Set(int,string) 将用户ID/类型和生成的Token绑定,本方法返回缓存中的Key名称

```C#
#Startup.cs
app.UseSimApiAuth();
```
调用本中间件,然后再需要登录认证的地方,使用 [YYAuth] 特性,即可完成检测登录相关的操作,
如果需要获取用户的ID, 只需要 直接使用 LoginId 属性即可获取

4. 统一返回
所有Response 均需要继承 SimApiBaseResponse类


5. 异常处理
本异常中间件封装了API错误的异常处理,控制器可以使用 Error(int,string) 直接返回API错误

```C#
#Startup.cs
app.UseSimApiException();
```