Azure Functions中如何用同路由不同参数定义两个API端点？

由于Azure Functions默认不会根据查询参数区分同路由的HTTP触发器，你可以通过自定义路由约束来实现两个函数的区分触发，同时保证OpenAPI规范的正确性。

方法一：自定义查询参数路由约束（推荐） #

通过实现IRouteConstraint接口，创建一个约束规则，只有当请求包含指定查询参数时，才会触发对应的函数。

1. 定义自定义约束类 #

public class RequiredQueryParamConstraint : IRouteConstraint
{
    private readonly string _requiredParam;

    public RequiredQueryParamConstraint(string requiredParam)
    {
        _requiredParam = requiredParam;
    }

    public bool Match(HttpContext httpContext, IRouter route, string routeKey, RouteValueDictionary values, RouteDirection routeDirection)
    {
        // 检查请求是否包含指定的查询参数
        return httpContext.Request.Query.ContainsKey(_requiredParam);
    }
}

2. 注册路由约束 #

在项目的Startup.cs（隔离进程模型用Program.cs）中注册自定义约束：

builder.Services.AddRouting(options =>
{
    // 将约束映射到自定义类
    options.ConstraintMap.Add("requiredQueryParam", typeof(RequiredQueryParamConstraint));
});

3. 配置两个函数的触发器 #

按ID查询的函数

[FunctionName("GetTemplateById")]
[OpenApiOperation(operationId: "Get-Template-ById", tags: new[] { "Get-Template" })]
[OpenApiParameter(name: "id", In = ParameterLocation.Query, Required = true, Description = "template id")]
[OpenApiResponseWithBody(statusCode: HttpStatusCode.OK, contentType: "application/json", bodyType: typeof(JObject), Description = "The OK response")]
[OpenApiResponseWithoutBody(statusCode: HttpStatusCode.Unauthorized, Summary = "Unauthorized Access", Description = "Unauthorized Access.")]
public async Task<IActionResult> GetTemplateById(
[HttpTrigger(AuthorizationLevel.Anonymous, "get", Route = "template/{*catchall:requiredQueryParam(id)}")] HttpRequest req)
{
    var id = req.Query["id"].ToString();
    // 处理按ID查询的业务逻辑
    var response = await GetTemplateFromDbById(id);
    
    return new ObjectResult(response);
}

按名称查询的函数

[FunctionName("GetTemplateByName")]
[OpenApiOperation(operationId: "Get-Template-ByName", tags: new[] { "Get-Template" })]
[OpenApiParameter(name: "name", In = ParameterLocation.Query, Required = true, Description = "template name")]
[OpenApiResponseWithBody(statusCode: HttpStatusCode.OK, contentType: "application/json", bodyType: typeof(JObject), Description = "The OK response")]
[OpenApiResponseWithoutBody(statusCode: HttpStatusCode.Unauthorized, Summary = "Unauthorized Access", Description = "Unauthorized Access.")]
public async Task<IActionResult> GetTemplateByName(
[HttpTrigger(AuthorizationLevel.Anonymous, "get", Route = "template/{*catchall:requiredQueryParam(name)}")] HttpRequest req)
{
    var name = req.Query["name"].ToString();
    // 处理按名称查询的业务逻辑
    var response = await GetTemplateFromDbByName(name);
    
    return new ObjectResult(response);
}

关键说明 #

• {*catchall}是通配符，用于匹配路径的任意后缀，确保路由基础路径始终为/template。
• requiredQueryParam(id)和requiredQueryParam(name)会触发自定义约束，仅当请求包含对应查询参数时，才会匹配对应的函数。
• 两个函数的OpenApiOperation需设置不同的operationId，这样Swagger文档会展示两个独立的接口操作，分别对应ID和名称查询。
• 如果请求同时携带id和name参数，会触发第一个加载的函数（取决于项目编译顺序），可以在约束类中添加逻辑，限制仅允许存在其中一个参数。

内容的提问来源于stack exchange，提问作者Sandeep Thomas