ASP.NET Core Web项目编写API并返回结构化Json

admin

从ASP.NET MVC(.NET Framework)开发转为ASP.NET Core MVC(.NET Core)开发需要一个逐步摸索的过程，因为微软为了实现跨平台而重写了所有的dll，而且许多接口方法也都重写了。

我用的是Visual Studio 2019 Enterprise

【1】首先，选择项目类型并创建

【2】选择项目模版（虽然我们开发的是API项目，但是因为模式选择的还是MVC，所以模板还是选择MVC项目）

【3】创建实体类

1. using System;
2. using System.Collections.Generic;
3. using System.Linq;
4. using System.Threading.Tasks;
6. namespace core1.Models
7. {
8. public class User
9. {
10. public int Id { get; set; }
11. public string Username { get; set; }
12. public string Phonenumber { get; set; }
13. public string Password { get; set; }
14. public DateTime CreateTime { get; set; }
15. public string Remark { get; set; }
16. public string ImageUrl { get; set; }
17. public string Feedback { get; set; }
18. }
19. }

复制代码

【4】创建数据库上下文（注：我的数据库和表是之前已经创建好的）

1. using Microsoft.EntityFrameworkCore;
2. using System;
3. using System.Collections.Generic;
4. using System.Linq;
5. using System.Threading.Tasks;
7. namespace core1.Models
8. {
9. public class DbEntity : DbContext
10. {
11. public DbSet<User> Users { get; set; }
12. protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
13. {
14. optionsBuilder.UseSqlServer(@"data source=/*数据库地址*/;initial catalog=/*数据库名称*/;User Id=/*数据库账户名*/;Password=/*数据库密码*/ ");
16. }
18. }
19. }

复制代码

【5】创建Controller

     所有创建的Controller都是默认继承ControllerBase,这是所有MVC控制器的基类，经过测试发现不支持重写Dispose方法和Newtonsoft.Json，之后我选择将ControllerBase改为Controller（其实也就是选择了MVCController），完美兼容，在ASP.NET MVC中，我通常使用IHttpActionResult这一数据返回类型返回Json格式数据，但在Core中显然不支持，所以我更换为了IActionResult。  

     此外，我还将类上方的路径格式从

1. [Route("api/[controller]")]

复制代码

改为

1. [Route("api/[controller]/[action]")]

复制代码

否则无法访问特定的方法。

完整代码：

1. using System;
2. using System.Collections.Generic;
3. using System.Linq;
4. using System.Threading.Tasks;
5. using Microsoft.AspNetCore.Http;
6. using Microsoft.AspNetCore.Mvc;
7. using Microsoft.EntityFrameworkCore;
8. using core1.Models;
9. using System.Net.Http;
10. using Parttime.Helper;
12. namespace core1.Controllers
13. {
14. [Route("api/[controller]/[action]")]
15. [ApiController]
16. public class UsersController : Controller
17. {
18. private DbEntity db = new DbEntity();
19. protected override void Dispose(bool disposing)
20. {
21. if (disposing) db.Dispose();
22. base.Dispose(disposing);
23. }
25. //[Route("Users")]
26. public IActionResult GetUsers()
27. {
28. List<User> users = db.Users.ToList();
29. return Json(new
30. {
31. datas =users.Select(s=>new
32. {
33. s.Id,
34. s.Username,
35. s.Phonenumber,
36. s.Password,
37. s.CreateTime,
38. s.ImageUrl
39. })
40. });
41. }
42. }
43. }

复制代码

返回类型也可以使用其他兼容Json的类型。

【6】接口测试

利用Postman对编写好的接口进行测试：

可以发现，数据成功获取到了。

最近在学习Core和Docker，后面还会继续与大家分享。

 

 

来源：https://blog.csdn.net/qq_38890412/article/details/94214547
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！