当前位置：首页 > news >正文

NetCoreKevin-DDD-微服务-WebApi-AI智能体、AISK集成、MCP协议服务、SignalR、Quartz 框架-13-API文档

news 2025/9/2 7:12:22

参考资料

https://github.com/junkai-li/NetCoreKevin

https://gitee.com/netkevin-li/NetCoreKevin

API文档

执行摘要

NetCoreKevin 是一个基于 .NET Core 的综合性项目，提供了丰富的 API 接口，用于处理第三方支付、用户管理、标记操作和系统授权等功能。本文档详细描述了所有公共 API 端点，包括路径、HTTP 方法、参数、请求示例、响应格式和错误代码，旨在帮助初学者和高级开发者快速集成和使用这些 API。

系统架构

NetCoreKevin 采用分层架构设计，包括控制器层、服务层和数据访问层。控制器层负责处理 HTTP 请求并调用相应的服务逻辑。以下是系统的简化架构图：

核心组件

1. PayController

负责处理第三方支付相关操作，支持微信和支付宝支付。

创建微信小程序支付 (/api/Pay/CreateWeiXinMiniAppPay)
- HTTP 方法: GET
- 参数: orderno (订单号, string), weixinkeyid (微信密钥ID, Guid)
- 功能: 在微信商户平台创建支付订单，返回支付参数。
- 使用场景: 用于微信小程序内发起支付。
- 限制条件: 需要用户已绑定微信账号，且订单存在。
- 请求示例: GET /api/Pay/CreateWeiXinMiniAppPay?orderno=123456&weixinkeyid=guid-value
- 响应格式: 返回 dtoCreatePayMiniApp 对象，包含支付所需参数。
- 错误代码: 400 (订单不存在或参数错误)
- 示例代码:
```
var response = await httpClient.GetAsync("https://api.example.com/api/Pay/CreateWeiXinMiniAppPay?orderno=123456&weixinkeyid=guid-value");
var payData = await response.Content.ReadAsAsync<DtoCreatePayMiniApp>();
```
微信支付异步通知 (/api/Pay/WeiXinPayNotify)
- HTTP 方法: POST
- 参数: 无 (接收微信回调数据)
- 功能: 处理微信支付结果通知，更新订单状态。
- 使用场景: 微信支付成功后，服务器接收通知。
- 限制条件: 仅限微信服务器调用。
- 响应格式: XML 格式字符串，包含处理结果。
- 错误代码: FAIL (通知处理失败)

类似地，其他支付相关端点（如支付宝支付创建和通知）也遵循类似模式，详细内容将在完整文档中列出。

2. SignController

处理与标记相关的操作。

获取标记总数 (/api/Sign/GetSignCount)
- HTTP 方法: GET
- 参数: table (表名, string), tableId (表ID, Guid), sign (标记类型, string)
- 功能: 查询特定表和ID下的标记总数。
- 使用场景: 用于统计用户对内容的点赞或收藏数。
- 限制条件: 无
- 请求示例: GET /api/Sign/GetSignCount?table=article&tableId=guid-value&sign=like
- 响应格式: 返回整数值，表示标记总数。
- 错误代码: 无
- 示例代码:
```
var response = await httpClient.GetAsync("https://api.example.com/api/Sign/GetSignCount?table=article&tableId=guid-value&sign=like");
var count = await response.Content.ReadAsAsync<int>();
```

3. UserController

处理用户相关操作。

获取用户信息 (/api/User/GetUser)
- HTTP 方法: GET
- 参数: userId (用户ID, Guid)
- 功能: 根据用户ID获取用户信息。
- 使用场景: 用户个人中心显示用户信息。
- 限制条件: 需要授权访问。
- 请求示例: GET /api/User/GetUser?userId=guid-value
- 响应格式: 返回 dtoUser 对象，包含用户信息。
- 错误代码: 401 (未授权), 404 (用户不存在)
- 示例代码:
```
var response = await httpClient.GetAsync("https://api.example.com/api/User/GetUser?userId=guid-value", headers: new { Authorization = "Bearer token" });
var user = await response.Content.ReadAsAsync<DtoUser>();
```

4. AuthorizeController

处理系统访问授权。

获取令牌 (/api/Authorize/GetToken)

HTTP 方法: POST
参数: login (登录信息, dtoLogin)
功能: 通过用户名和密码获取访问令牌。
使用场景: 用户登录系统。
限制条件: 无

请求示例:

POST /api/Authorize/GetToken
Content-Type: application/json
{"username": "user","password": "pass"
}

响应格式: 返回字符串，包含访问令牌。
错误代码: 400 (用户名或密码错误)

示例代码:

var loginData = new { username = "user", password = "pass" };
var response = await httpClient.PostAsJsonAsync("https://api.example.com/api/Authorize/GetToken", loginData);
var token = await response.Content.ReadAsStringAsync();