FastDotNet
导航
仓库

简体中文

English

简体中文

English

Appearance

简体中文 | English · 返回 README

Fast.NET 入门 ​

本文提供从选择模块、注册服务到验证应用的最短路径。完整模块边界和配置入口见模块手册。

前置条件 ​

  • 使用 Fast.NET 的应用面向 .NET 8、.NET 9 或 .NET 10。
  • 构建 Fast.NET 源码仓库需要其 global.json 指定的 .NET 10 SDK。
  • Redis、Consul、数据库等外部服务只在安装对应模块时需要；基础 SDK 接入无需外部服务。

创建应用 ​

bash
dotnet new webapi -n MyFastApp -f net10.0
cd MyFastApp
dotnet add package Fast.NET.Core --version 3.5.38
dotnet add package Fast.Serialization.System.Text.Json --version 3.5.20
dotnet add package Fast.Swagger --version 3.5.34

Fast.Serialization.System.Text.Json 与 Fast.Serialization.Newtonsoft.Json 通常二选一。不要为了使用某个单独能力安装所有 Fast.NET 包。

最小配置 ​

csharp
using Fast.NET.Core;
using Fast.Serialization;
using Fast.Swagger;

var builder = WebApplication.CreateBuilder(args);

builder.Initialize();
builder.Services.AddSerialization();
builder.Services.AddControllers();
builder.Services.AddSwaggerDocuments(builder.Configuration);

var app = builder.Build();

app.UseSwaggerDocuments();
app.MapControllers();
app.MapGet("/health", () => Results.Ok(new {status = "ok"}));

app.Run();

appsettings.json：

json
{
	"SwaggerSettings": {
		"Enable": true,
		"DocumentTitle": "My Fast.NET API",
		"EnableAuthorized": false
	}
}

如果使用 Fast.DynamicApplication，必须先调用 AddControllers() 或 AddControllersWithViews()，再调用 AddDynamicApplication()。

从源码构建 ​

以下命令的工作目录是 Fast.NET 源码仓库根目录。文档维护不会自动执行这些命令，也不会启动生成的应用。

bash
dotnet restore Fast.NET.sln
dotnet build Fast.NET.sln -c Release --no-restore
dotnet pack Fast.NET.sln -c Release --no-build --no-restore -p:WarnOnPackingNonPackableProject=false

Windows 用户可以通过仓库的单文件入口依次还原、构建并打包：

bat
UploadNuget.bat pack

批处理文件始终先构建再打包，pack 模式不会发布。生成的包位于 nupkgs/；可选的全量或单包发布流程见发布指南。

下一步 ​

示例编译验证 ​

文档示例编译基线面向 net8.0;net9.0;net10.0，固定引用 Fast.NET.Core 3.5.38、Fast.Serialization.System.Text.Json 3.5.20 和 Fast.Swagger 3.5.34。

在自己的应用项目根目录使用上述固定包引用，再执行：

bash
dotnet restore
dotnet build -c Release --no-restore

这些命令只还原并编译项目，不启动应用。本轮只读核验与模块文档补充没有执行它们；其他模块页面新增片段不在此工程的编译范围内。