如何使用 ApiController 修复路由失败？

Question

我有一个名为“OdeToFood”的小型 ASP.NET Core Web 应用程序项目。开发环境包括：

1. IDE：Windows 10 PC 上的 Visual Studio 2019
2. ASP.NET Core 3.1
3. 使用 Dapper 从 SQL DB 访问数据
4. 不使用 MVC

在其中一个网页中，将使用 jQuery .ajax 从 DB 中检索记录。我添加了一个类型为“具有读/写操作的 API 控制器”的 ApiController，因为此项目中未使用 EF。

这是VS自动生成的代码（没有做任何改动）。

namespace OdeToFood.Api
{
    [Route("api/[controller]")]
    [ApiController]
    public class RestaurantsController : ControllerBase
    {
        // GET: api/<RestaurantsController>
        [HttpGet]
        public IEnumerable<string> Get()
        {
            return new string[] { "value1", "value2" };
        }

        // GET api/<RestaurantsController>/5
        [HttpGet("{id}")]
        public string Get(int id)
        {
            return "value";
        }

        // POST api/<RestaurantsController>
        [HttpPost]
        public void Post([FromBody] string value)
        {
        }

        // PUT api/<RestaurantsController>/5
        [HttpPut("{id}")]
        public void Put(int id, [FromBody] string value)
        {
        }

        // DELETE api/<RestaurantsController>/5
        [HttpDelete("{id}")]
        public void Delete(int id)
        {
        }
    }
}

我尝试使用以下 URL 从浏览器中对其进行测试：

1. https://localhost:44361/api/Restaurants
2. https://localhost:44361/api/Restaurants/8
3. https://localhost:44361/api/RestaurantsController
4. https://localhost:44361/api/RestaurantsController/8

它们都因 HTTP 404 错误而失败。

由于上面的代码已经使用 [Route ...] 的“属性路由”，我认为前 2 个 URL 的 int 测试应该可以工作。但他们没有。我不知道为什么。任何帮助或建议将不胜感激。

在 startup.cs 文件中，configure 部分有以下设置：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }
    else
    {
        app.UseExceptionHandler("/Error");
        // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
        app.UseHsts();
    }

    app.UseHttpsRedirection();
    app.UseStaticFiles();

    app.UseRouting();

    app.UseAuthorization();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapRazorPages();
    });
}

Answer 1

在您的 startup.cs 中尝试以下操作

 app.UseEndpoints(endpoints =>
    {
    endpoints.MapControllers();
    });

在下方评论；

endpoints.MapRazorPages();

Answer 2

Your Scenario:

虽然解决方案很简单，但我觉得解释得更多 让您摆脱任何进一步的困惑。

正如你所说的"Visual Studio 2019"，所以如果你已经采取了asp.net core web api 项目，它将使用weather forecast api controller 创建，默认startup.cs 如下所示：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

            app.UseRouting();

            app.UseAuthorization();

            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllers();
            });
        }

因此，如果您直接运行该项目，它应该使用default action 运行，如下所示：

        [HttpGet]
        public IEnumerable<WeatherForecast> Get()
        {
            var rng = new Random();
            return Enumerable.Range(1, 5).Select(index => new WeatherForecast
            {
                Date = DateTime.Now.AddDays(index),
                TemperatureC = rng.Next(-20, 55),
                Summary = Summaries[rng.Next(Summaries.Length)]
            })
            .ToArray();
        }

所以现在来到你的项目configuration，其中包含类似 下面：

app.UseEndpoints(endpoints =>
    {
        endpoints.MapRazorPages();
    });

表示它正在寻找simple mvc razor page 以及当您尝试时 要点击URLs 1. https://localhost:44361/api/Restaurants or 2.https://localhost:44361/api/Restaurants/8 中的任何一个，它应该得到404，因为它没有相应地路由。因此，您的 routing template 直接与 route api controller 不正确。 endpoints.MapRazorPages() 通常用于Razor mvc page routing。

Solution:

如果您在使用RestaurantsController 时可以添加API controller，我想它会像您发布的那样。 如果您替换下面的service

，请求应该按预期路由

       app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllers();
            });

Note: 如果需要，您甚至可以override 您的路线模板。如果你想要哪个，你也可以have a look here conventional route.

Output:

我尝试向您展示的是什么会误导您并强化您的想法。如果您有任何进一步的疑问，请查看我们的official document here。希望对您有所帮助。