SuperAPI AI 工具集

scalar

通用与其它

查看项目

更新于 10-16 02:30

技能介绍

用途:Scalar 用于在代码库中生成并配置 OpenAPI 文档界面,替代 Swagger/Swashbuckle。所有服务使用 .NET 10 内置的 AddOpenApi() 配合 Scalar 的 MapScalarApiReference() 提供 UI,并统一采用 Purple 主题。

主要能力:注册 OpenAPI 服务(AddOpenApi())、暴露 /openapi/v1.json(MapOpenApi())、在 /scalar 挂载 Scalar UI(MapScalarApiReference())。支持设置标题、主题(如 ScalarTheme.Purple)、默认 HTTP 客户端(如 ScalarTarget.CSharp、ScalarClient.HttpClient)。API 网关可聚合各服务的 OpenAPI 文档,并通过 WithOpenApiRoutePattern 指向聚合端点。支持用 Markdown 编写丰富的 OpenAPI 描述,通过 AddDocumentTransformer 设置标题、版本和描述。端点可用 WithName、WithSummary、WithDescription、WithTags 补充文档信息。

使用方式:在 Program.cs 中调用 builder.Services.AddOpenApi(),构建后调用 app.MapOpenApi(),在开发环境下调用 app.MapScalarApiReference(options => options.WithTitle(...).WithTheme(ScalarTheme.Purple).WithDefaultHttpClient(...))。网关聚合示例中通过 MapGet 暴露 /openapi/aggregated.json 并排除描述。

适用场景:为微服务添加 API 文档、配置 OpenAPI 端点、自定义主题与代码生成目标、聚合网关文档。

限制:资料未提供收费、价格、平台支持范围及具体效果等信息。相关技能包括 minimal-apis、aspire、yarp。可通过 Context7 获取最新文档,库 ID 为 /websites/guides_scalar。