Skip to content

Fast.DynamicApplication 公开 API

目标 net8.0;net9.0;net10.0。本页为语法声明与 XML 注释参考,运行示例和边界见模块用法

源码提交:43554c07f6c216f80b509bd535c0a5b66ae7f2e8。维护流程:scripts/export-dotnet-api.ps1;普通站点构建直接消费此文件。

Fast.DynamicApplication.ApiDescriptionSettingsAttribute

源码 · 目标:net8.0、net9.0、net10.0

csharp
[SuppressSniffer]
[AttributeUsage(AttributeTargets.Interface | AttributeTargets.Class | AttributeTargets.Method)]
public sealed class ApiDescriptionSettingsAttribute : ApiExplorerSettingsAttribute

接口描述设置

Fast.DynamicApplication.ApiDescriptionSettingsAttribute.ApiDescriptionSettingsAttribute

源码 · 目标:net8.0、net9.0、net10.0

csharp
public ApiDescriptionSettingsAttribute()

初始化类的新实例

Fast.DynamicApplication.ApiDescriptionSettingsAttribute.ApiDescriptionSettingsAttribute

源码 · 目标:net8.0、net9.0、net10.0

csharp
public ApiDescriptionSettingsAttribute(bool enabled)

初始化类的新实例

  • 参数 enabled:是否启用该功能

Fast.DynamicApplication.ApiDescriptionSettingsAttribute.ApiDescriptionSettingsAttribute

源码 · 目标:net8.0、net9.0、net10.0

csharp
public ApiDescriptionSettingsAttribute(params string[] groups)

初始化类的新实例

  • 参数 groups:文档分组集合

Fast.DynamicApplication.ApiDescriptionSettingsAttribute.Name

源码 · 目标:net8.0、net9.0、net10.0

csharp
public string Name { get; set; }

自定义名称

Fast.DynamicApplication.ApiDescriptionSettingsAttribute.Module

源码 · 目标:net8.0、net9.0、net10.0

csharp
public string Module { get; set; }

模块名

Fast.DynamicApplication.ApiDescriptionSettingsAttribute.Version

源码 · 目标:net8.0、net9.0、net10.0

csharp
public string Version { get; set; }

版本号

Fast.DynamicApplication.ApiDescriptionSettingsAttribute.Groups

源码 · 目标:net8.0、net9.0、net10.0

csharp
public string[] Groups { get; set; }

分组

Fast.DynamicApplication.ApiDescriptionSettingsAttribute.Order

源码 · 目标:net8.0、net9.0、net10.0

csharp
public int Order { get; set; }

排序

Fast.DynamicApplication.ApiDescriptionSettingsAttribute.Description

源码 · 目标:net8.0、net9.0、net10.0

csharp
public string Description { get; set; }

额外描述,支持 HTML

Fast.DynamicApplication.DynamicApplicationContext

源码 · 目标:net8.0、net9.0、net10.0

csharp
[SuppressSniffer]
public static class DynamicApplicationContext

Dynamic Application 上下文

Fast.DynamicApplication.DynamicApplicationContext.RoutePrefix

源码 · 目标:net8.0、net9.0、net10.0

csharp
public static string RoutePrefix { get; internal set; } = null;

路由前缀

Fast.DynamicApplication.DynamicApplicationContext.ControllerOrderCollection

源码 · 目标:net8.0、net9.0、net10.0

csharp
public static ConcurrentDictionary<string, (string, int, Type)> ControllerOrderCollection { get; set; } = new();

控制器排序集合

Fast.DynamicApplication.DynamicApplicationContext.IsApiController

源码 · 目标:net8.0、net9.0、net10.0

csharp
public static bool IsApiController(Type type)

是否是 API 控制器

  • 参数 type:目标类型
  • 返回:满足条件时返回 true;否则返回 false

Fast.DynamicApplication.IServiceCollectionExtension

源码 · 目标:net8.0、net9.0、net10.0

csharp
[SuppressSniffer]
public static class IServiceCollectionExtension

IServiceCollection 提供动态 API 扩展方法

Fast.DynamicApplication.IServiceCollectionExtension.AddDynamicApplication

源码 · 目标:net8.0、net9.0、net10.0

csharp
public static IServiceCollection AddDynamicApplication(this IServiceCollection services, string routePrefix = null)

添加动态 API 服务

  • 参数 services:要添加服务的服务集合
  • 参数 routePrefix:应用于生成路由的统一前缀
  • 返回:返回 services,便于链式调用

Fast.DynamicApplication.IDynamicApplication

源码 · 目标:net8.0、net9.0、net10.0

csharp
[SuppressSniffer]
public interface IDynamicApplication

动态 API 应用依赖接口