FastEndpoints项目中使用Scalar实现交互式API文档

在FastEndpoints项目中，开发者经常需要为API提供交互式文档。虽然FastEndpoints本身提供了Swagger集成，但有些开发者可能希望使用微软的AspNetCore.OpenApi包或者Scalar这样的替代方案来增强API文档体验。

FastEndpoints与Scalar的集成方案

FastEndpoints项目目前没有直接集成微软的AspNetCore.OpenApi包的计划，但开发者可以轻松地使用Scalar来实现交互式API文档功能。以下是实现这一集成的典型代码示例：

using Scalar.AspNetCore;

var bld = WebApplication.CreateBuilder(args);
bld.Services
   .AddFastEndpoints()
   .SwaggerDocument();

var app = bld.Build();
app.UseFastEndpoints();

if (app.Environment.IsDevelopment())
{
    app.UseOpenApi(c => c.Path = "/openapi/{documentName}.json");
    app.MapScalarApiReference();
}

app.Run();

在这个配置中，Scalar UI默认可以通过http://localhost:{port}/scalar/v1访问，其中v1是默认的文档名称。

处理API版本化的问题

当项目中使用API版本控制时，开发者可能会遇到Scalar只显示非版本化端点的问题。这是因为需要正确配置文档名称和版本信息。

以下是解决这个问题的配置方法：

builder.Services.SwaggerDocument(o =>
{
    o.DocumentSettings = s =>
    {
        s.DocumentName = "v1";
        s.Version = "v1";
    };
});

通过明确设置DocumentName和Version属性，可以确保版本化的端点正确显示在Scalar文档中。

技术实现原理

这种集成方式的工作原理是：

1. FastEndpoints生成OpenAPI规范文档
2. 通过UseOpenApi中间件使文档在指定路径可用
3. Scalar从该路径加载OpenAPI规范并渲染交互式UI

这种架构的优点是保持了FastEndpoints的核心功能，同时允许开发者选择自己喜欢的API文档工具。

最佳实践建议

1. 仅在开发环境中启用Scalar，生产环境应该禁用
2. 考虑为不同版本创建单独的文档配置
3. 确保端点摘要和描述信息完整，以获得最佳的文档体验
4. 定期检查Scalar和FastEndpoints的更新，以获得最新功能

通过这种方式，开发者可以在FastEndpoints项目中获得功能丰富且用户友好的API文档体验，而无需依赖特定的文档工具链。