Galosys.Foundation.AspNetCore.DynamicApi 26.5.20.1

Galosys.Foundation.AspNetCore.DynamicApi

成熟度: 🟢 稳定 — 生产可用，测试充分，活跃维护

简介

Galosys.Foundation.AspNetCore.DynamicApi 是 ASP.NET Core 动态 API 生成模块，通过特性标记自动将服务类转换为 RESTful API 控制器，支持自定义路由规则和统一响应模型。

特性

动态 API 生成

• 自动控制器发现 - 基于 [RestController] 特性自动识别服务类
• 约定式路由 - 根据命名空间和类名自动生成 RESTful 路由
• 方法名转换 - 自动移除 Async 等后缀生成简洁的 Action 名称
• 路由命名策略 - 支持 CamelCase、SnakeCase、KebabCase 命名规则

统一响应模型

• 成功响应 - Succeed(data) 返回标准成功响应
• 失败响应 - Fail(errorCode, errorMsg) 返回标准错误响应
• 类型安全 - 支持泛型响应模型

路由生成规则

/api/{version}/{namespace}/{controller}/{action}

• 版本 - 默认 v1
• 命名空间 - 移除 Application、App 等后缀
• 控制器 - 移除 AppService、Service 等后缀
• 动作 - 移除 Async 后缀

安装

dotnet add package Galosys.Foundation.AspNetCore.DynamicApi

使用

注册服务

services.AddDynamicApi(); // 注册动态 API 服务

定义服务类

[RestController]
public class OrderAppService
{
 public async Task<OrderDto> GetOrderAsync(int id)
 {
 // 业务逻辑
 }
 
 public async Task<List<OrderDto>> GetOrdersAsync()
 {
 // 业务逻辑
 }
 
 public async Task<OrderDto> CreateOrderAsync(CreateOrderRequest request)
 {
 // 业务逻辑
 }
}

使用统一响应

[RestController]
public class ProductAppService : RestController
{
 public UnifiedResponse GetProduct(int id)
 {
 var product = _repository.Get(id);
 if (product == null)
 return Fail(BizErrorCode.NotFound, "产品不存在");
 
 return Succeed(product);
 }
}

配置路由策略

[RestController(CasingStrategy = CasingStrategy.KebabCase)]
public class UserAppService
{
 // 路由: /api/v1/user/get-user
 public async Task<UserDto> GetUserAsync(int id)
 {
 // 业务逻辑
 }
}

自定义版本和场景

[RestController(Scene = "admin", Version = "v2")]
public class AdminOrderAppService
{
 // 路由: /admin/v2/admin-order/get-order
 public async Task<OrderDto> GetOrderAsync(int id)
 {
 // 业务逻辑
 }
}

核心类

路由命名策略

配置选项

[RestController(
 Scene = "api", // 路由场景前缀
 Version = "v1", // API 版本
 CasingStrategy = CasingStrategy.KebabCase // 命名策略
)]

支持的后缀约定

控制器后缀（自动移除）:

• AppService, AppSrv, AppSvc
• ApplicationService, ApplicationSrv, ApplicationSvc
• Service, Svc

方法后缀（自动移除）:

• Async

命名空间后缀（自动移除）:

• Application, App

依赖

• Microsoft.AspNetCore.App
• Galosys.Foundation.AspNetCore
• Galosys.Foundation.Core