杨中科 ASP.NETCore WebAPI 控制器及返回值、参数问题-个人在线分享

控制器及返回值

控制器类

1、ControllerBase与Controller
webapi的controller 继承自 ControllerBase
杨中科 ASP.NETCore WebAPI 控制器及返回值、参数问题插图
webmvc 继承自controller

controller 继承自controllerbase

2、控制器类可以不显式地继承自任何类
还是需要添加特性
杨中科 ASP.NETCore WebAPI 控制器及返回值、参数问题插图(3)

运行：
杨中科 ASP.NETCore WebAPI 控制器及返回值、参数问题插图(4)

Action方法的异步

1、Action方法既可以同步也可以异步。
2、异步Action方法的名字一般不需要以Async结尾。
3、Web API中Action方法的返回值如果是普通数据类型，那么返回值就会默认被序列化为Json格式。
4、Web API中的Action方法的返回值同样支持IActionResult类型，不包含类型信息，因此Swagger等无法推断出类型，所以推荐用ActionResult，它支持类型转换，从而用起来更简单。

示例：
杨中科 ASP.NETCore WebAPI 控制器及返回值、参数问题插图(5)
运行结果：

普通类型序列化为格式
首先创建一个Person类

运行结果：

普通抛出异常方式，会在客户端直接显示异常信息。这是很不友好的

运行结果：

希望返回404
将返回值改为IActionResult
杨中科 ASP.NETCore WebAPI 控制器及返回值、参数问题插图(12)
运行结果：

也可添加泛型

【总结：】
如果你的返回类型只有一种类型，那么直接使用哪一种类型得返回类型即可，若有多种则可以使用IAcitonResult

Asp.Net Core Web API Action 方法参数

add 方法使用[HTTPGET]默认的是querystring的方式传递
杨中科 ASP.NETCore WebAPI 控制器及返回值、参数问题插图(15)
思考如何手动指定数据来自于querystring 还是路径还是来自请求体

捕捉URL占位符

1、在[HttpGet]、[HttpPost]等中使用占位符，比如[schoolName}，捕捉路径中的内容，从而供Action方法的参数使用。
Students/GetAll/school/MIT/class/A001
[HttpGet(“school/schoolNamel/class (classNol”)]
2、捕捉的值会被自动赋值给Action中同名的参数如果名字不一致，可以用[FromRoute(Name=“名字”)]
3、演示混用
杨中科 ASP.NETCore WebAPI 控制器及返回值、参数问题插图(16)
运行结果：

名字不同时：
杨中科 ASP.NETCore WebAPI 控制器及返回值、参数问题插图(18)
运行结果：

HttpPost 方式

运行结果

捕捉QUERYSTRING的值

1、使用[FromQuery]来获取QueryString中的值。如果名字一致，只要为参数添加[FromQuery]即可;而如果名字不一致[FromQuery(Name = 名字)]。
杨中科 ASP.NETCore WebAPI 控制器及返回值、参数问题插图(22)

2、QueryString和Route可以混用

JSON 报文体

1、Web API的开发模式下，Json格式的请求体是主流
2、只要声明一个模型类和Json请求的格式一致即可。
3、也是可以把从URL获取参数、从请求报文体获取数据等这些混合使用。
[HttpPost(“classld/(classld)”)]
public ActionResult AddNew(long classldStudentModel s)
4、一定要设定请求头中的Content-Type为application/json，而且数据必须是合法的json格式

复杂参数类型，可以用类的方式
杨中科 ASP.NETCore WebAPI 控制器及返回值、参数问题插图(23)
请求方式相对应即可（2声明一个模型类和Json请求的格式一致即可）

混合使用

运行结果：