在 ASP.NET Core Web API 中创建 return OData 的 enbdpoints

Question

我正在尝试在 ASP.NET Core Web API 中创建 OData 端点。

我使用模板创建了一个新的 ASP.NET Core Web API 并向其中添加了 Microsoft.AspNetCore.OData 包 (v7.0.0-beta1)，假设它是必需的。

我找不到任何关于如何开始使用它的文档。如果有人能告诉我如何将默认的 ValuesController 简单地转换为 return OData 而不是 Json 那会很棒。

Answer 1

I created a new ASP.NET Core Web API using the template and added the Microsoft.AspNetCore.OData package (v7.0.0-beta1) to it assuming it is required.

I can't find any documentation on how to get started with this. If anyone can tell me how I would simply turn the default ValuesController to return OData instead of Json that would be great.

根据您的描述，我建议您可以尝试按照以下步骤来创建 net core odata web api。

1.Install Microsoft.AspNetCore.OData 7.0.0-beta1

2.Install Microsoft.EntityFrameworkCore

3.Create 模型 class 和 DBContext class.

public class Person
{
    [Key]
    public int Id { get; set; }
    [Required]
    public string Name { get; set; }
    [Required]
    public int Age { get; set; }
}

public class ApplicationDbContext : DbContext
{
    public ApplicationDbContext(DbContextOptions options)
        : base(options)
    {
    }


    public DbSet<Person> Persons { get; set; }

}

4.Create一个Controller，在OData早期版本中可以继承自ODataController。但是在 ASP.NET Core 中，没有可用的 OData 控制器。所以你需要创建一个带有OData属性的普通控制器。

public class PersonController : Controller
{
    private readonly ApplicationDbContext _appDbContext;
    public PersonController(ApplicationDbContext sampleODataDbContext)
    {
        _appDbContext = sampleODataDbContext;
    }

    [EnableQuery]
    public IActionResult Get()
    {
        return Ok(_appDbContext.Persons.AsQueryable());
    }
}

5.Modify 添加 OData 中间件和 OData 路由的启动 class 代码。

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.AddDbContext<ApplicationDbContext>(options =>
options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection")));
        services.AddOData();
        services.AddMvc();

    }

    // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
    public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    {
        //Adding Model class to OData
        var builder = GetEdmModel(app.ApplicationServices);
        builder.EntitySet<Person>(nameof(Person));

        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }

        app.UseMvc((routebuilder =>
        {
            routebuilder.MapODataServiceRoute("odata","odata", builder.GetEdmModel());
        }));
    }

    private static ODataConventionModelBuilder GetEdmModel(IServiceProvider serviceProvider)
    {
        var builder = new ODataConventionModelBuilder(serviceProvider);
       
      return builder;
    }
}

6.Open 包管理器控制台创建 table：Add-Migration InitialCreate update-database

7.Run 申请

结果：

在 ASP.NET Core Web API 中创建 return OData 的 enbdpoints

Creating enbdpoints that return OData in ASP.NET Core Web API

c#

asp.net

odata

asp.net-core

asp.net-core-webapi