SuperAPI AI 工具集

scalar

编程与开发

查看项目

更新于 10-16 05:02

技能介绍

Scalar 是 .NET 10 推荐的 API 文档 UI,用于替代 Swagger UI,具备更快的渲染、内置深色模式、面向多种语言的代码生成以及完整的 OpenAPI 3.1 支持。

主要能力:可为主题(Default、Moon、Purple、BluePlanet、Saturn、Mars、DeepSpace、Kepler、Solarized、Laserwave)、默认 HTTP 客户端与目标语言、首选安全方案、侧栏与经典布局等做配置;支持多个 OpenAPI 文档自动或显式注册;支持鉴权预填(HTTP Bearer、API Key、OAuth2);可强制深色模式、自定义路由前缀。

使用方式:通过 AddOpenApi() 与 MapOpenApi() 生成并暴露 OpenAPI 文档,再用 app.MapScalarApiReference() 挂载 UI,默认路径为 /scalar/{documentName}。可传入选项委托进行定制,例如 WithTitle、WithTheme、WithDefaultHttpClient、WithPreferredScheme、WithProxy、WithSidebar。安全方案需通过 document transformer 写入 OpenAPI 文档,Scalar 本身不直接配置。

限制与注意事项:默认应仅在开发环境启用,用 IsDevelopment() 包裹 MapScalarApiReference();如需在生产暴露,应对 MapOpenApi 和 MapScalarApiReference 同时 RequireAuthorization。敏感 API 建议用 .WithProxy(null) 关闭外部代理,避免认证头经 proxy.scalar.com 传输。鉴权预填只应使用开发用测试令牌,禁止填入真实生产凭证。缺少安全方案 transformer 时 WithPreferredScheme 不生效。新 .NET 10 项目不应再使用 Swagger UI。资料未提供具体收费、价格或许可信息。