Does .NET core 2.1 web API support convention based routing?

Question

I am new to Web API and .net core, and I have a task to develop an API.

So I have created a default web API (framework: .NET Core 2.1) and tried adding the route map and i am getting an error.

guys can someone help me with routing.

Note: Cant use attribute based routing need to handle routes based on a convention like in MVC

My startup program:

public class Startup
{
    public Startup(IConfiguration configuration)
    {
        Configuration = configuration;
    }

    public IConfiguration Configuration { get; }

    // This method gets called by the runtime. Use this method to add services to the container.
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
    }

    // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
    public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }
        else
        {
            app.UseHsts();
        }

        //app.UseHttpsRedirection();
        app.UseMvc(routes =>
        {
        routes.MapRoute(
            name: "default",
            template: "{controller}/{action}/{id?}",
            defaults: new { controller = "Values", action = "dummyaction" });
        });
    }
}

And this is the error i am getting:

InvalidOperationException: Action 'myproject.Controllers.ValuesController.dummyaction (myproject)' does not have an attribute route. Action methods on controllers annotated with ApiControllerAttribute must be attribute routed.

Why can you not use attribute routing? Regardless, there is no convention based routing such as having a Get, Post, Put, Delete, etc. actions and having those automatically respond to those HTTP methods. — Chris Pratt
– Chris Pratt, Commented Aug 30, 2019 at 17:16
Chris Pratt so if I replace all my action methods with names like these "dummyaction" and in map route, if I give default action as "dummyaction" will I be able to perform convention-based routing — Tejaswi Pandava
– Tejaswi Pandava, Commented Aug 30, 2019 at 17:22

Tejaswi Pandava · Accepted Answer · 2019-08-30 18:19:29Z

How I got it working

even after using map route I was still getting the error which talks about attribute-based routing

app.UseMvc(routes =>
    {
    routes.MapRoute(
        name: "default",
        template: "{controller}/{action}/{id?}",
        defaults: new { controller = "Values", action = "dummyaction" });
    });

So in the error can you see this line "Action methods on controllers annotated with ApiControllerAttribute must be attribute routed."

Now in my controller, I was using this particular annotation/attribute "[ApiController]" by removing that I was able to perform convention-based routing.

also, I have updated the route as below

app.UseMvc(routes =>
{
     routes.MapRoute(
            name: "api",
            template: "api/{controller=Values}/{action=gogogo}/{id?}");
 });

references:

https://learn.microsoft.com/en-us/aspnet/core/mvc/controllers/routing?view=aspnetcore-2.2#mixed-routing-attribute-routing-vs-conventional-routing section(Mixed routing: Attribute routing vs conventional routing)

asp.net core web api center routing

Sadegh Hatami · Accepted Answer · 2019-08-30 17:22:36Z

0

You can do with this sample

namespace TodoApi.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class TodoController : Controller
   {
      [HttpGet("{id}")]
public async Task<ActionResult<TodoItem>> GetTodoItem(long id)
{
//do here
    }
}
}

For more information follow this link

answered Aug 30, 2019 at 17:22

Sadegh Hatami

1381 silver badge8 bronze badges

1 Comment

Tejaswi Pandava Over a year ago

I have a requirement of not to add individual routes to controllers and actions instead client wants a global route. Note: instead of get, post, put action names i will have name like studentlist, editstudent and so on

Collectives™ on Stack Overflow

Does .NET core 2.1 web API support convention based routing?

2 Answers 2

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related