Defining 2 API endpoints with same route, but with different parameters in Azure Functions

Question

I am trying to create an azure function app with two http trigger functions in it with open API specs, but both using same route but with different parameters.

Requirement to fetch some templates from Database. first way is when customer provides id, another way when customer provides name

Here is my function looks like

[FunctionName("GetTemplateById")]
[OpenApiOperation(operationId: "Get-Template", 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")] HttpRequest req)
{
    //some code using id parameter

    return new ObjectResult(response);
}

But I need another function where to fetch template by template name instead of ID. But how can I make it with the same route, but different parameter. I am not thinking about a solution where both parameters in single function and making both optional. Any other workaround?

Nicolas Boisvert · Accepted Answer · 2022-11-08 18:22:57Z

1

In order to follow REST api best practices i would recommand the following routes/url

http://yourApi/templates/{templateid}

to get a single template based on its key (id)

http://yourApi/templates?templateName='searchedName'

to get all templates, with possibility to filter on differents properties, in this case filtered on templateName

have a look at REST Resource Naming Guide

answered Nov 8, 2022 at 18:22

Nicolas Boisvert

1,2013 gold badges13 silver badges27 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

madmonk46 · Accepted Answer · 2022-11-04 15:07:22Z

0

Attribute Routing, specifically Route Constraints should allow you to do this in a way that's highly explicit about what route will be selected given the input.

answered Nov 4, 2022 at 15:07

madmonk46

5775 silver badges21 bronze badges

Collectives™ on Stack Overflow

Defining 2 API endpoints with same route, but with different parameters in Azure Functions

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related