首页
/ FastEndpoints项目中使用OpenAPI和Scalar实现API端点分组

FastEndpoints项目中使用OpenAPI和Scalar实现API端点分组

2025-06-08 14:07:18作者:齐添朝

在FastEndpoints框架中,合理组织API端点是提升API文档可读性和维护性的重要环节。本文将详细介绍如何通过OpenAPI规范和Scalar文档工具实现API端点的有效分组。

核心概念

FastEndpoints提供了简洁的方式来定义API端点分组,主要通过Tags()方法实现。每个端点可以被打上一个或多个标签,这些标签最终会转换为OpenAPI规范中的tags属性,并在API文档工具中呈现为分组。

正确配置方式

1. 基础配置

首先需要在Program.cs中进行正确的Swagger和Scalar配置:

var builder = WebApplication.CreateBuilder();
builder.Services.AddFastEndpoints()
    .SwaggerDocument(o =>
    {
        o.DocumentName = "v1";
        o.Title = "My API";
        o.Description = "API documentation";
    });

var app = builder.Build();
app.UseFastEndpoints(c =>
{
    c.Endpoints.RoutePrefix = "api";
    c.Serializer.Options.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;
    c.Serializer.Options.Converters.Add(new JsonStringEnumConverter());
});

if (app.Environment.IsDevelopment())
{
    app.UseSwaggerGen();
    app.MapScalarApiReference();
}

app.Run();

2. 端点分组实现

在端点类中,使用Tags()方法指定分组:

public class AssetsEndpoint : Endpoint<MyResponse>
{
    public override void Configure()
    {
        Get("/models");
        Tags("Assets", "3D Models"); // 可以指定多个标签
        Description("Operations about 3D models");
    }

    public override async Task HandleAsync(CancellationToken ct)
    {
        await SendOkAsync(ct);
    }
}

高级配置选项

1. 全局标签定义

可以在Swagger配置中预定义所有可能的标签:

builder.Services.AddFastEndpoints()
    .SwaggerDocument(o =>
    {
        o.DocumentName = "v1";
        o.Title = "My API";
        o.TagDescriptions = new Dictionary<string, string>
        {
            ["Assets"] = "Operations about 3D models",
            ["Users"] = "User management operations"
        };
    });

2. Scalar特定配置

可以针对Scalar文档工具进行特定配置:

app.MapScalarApiReference(o =>
{
    o.DocumentTitle = "My API Documentation";
    o.DefaultOpenAllTags = false; // 默认不展开所有分组
    o.ScalarVersion = "1.0.0";
});

常见问题解决

  1. 标签不显示问题:确保使用的是FastEndpoints内置的SwaggerDocument()方法,而非第三方库的类似方法。

  2. 分组不生效:检查端点类中是否正确调用了Tags()方法,并且标签名称与全局定义一致。

  3. 文档工具兼容性:FastEndpoints生成的OpenAPI规范与主流文档工具兼容,包括Swagger UI、Scalar、Redoc等。

最佳实践建议

  1. 保持标签名称简洁且具有描述性
  2. 为每个标签添加详细的描述信息
  3. 避免创建过多的标签分组
  4. 考虑API消费者的视角来设计分组逻辑
  5. 在开发环境启用文档,生产环境禁用

通过以上配置和实践,开发者可以轻松实现API端点的逻辑分组,提升API文档的可读性和易用性,为API消费者提供更好的使用体验。

登录后查看全文
热门项目推荐
相关项目推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
205
2.18 K
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
208
285
pytorchpytorch
Ascend Extension for PyTorch
Python
62
95
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
977
575
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
550
86
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
399
communitycommunity
本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息
393
27
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
1.2 K
133