杨中科 ASP.NETCore WebAPI 控制器及返回值、参数问题

控制器及返回值

控制器类

1、ControllerBase与Controller

webapi的controller 继承自 ControllerBase

webmvc 继承自controller

controller 继承自controllerbase

2、控制器类可以不显式地继承自任何类

还是需要添加特性

运行:

Action方法的异步

1、Action方法既可以同步也可以异步。

2、异步Action方法的名字一般不需要以Async结尾。

3、Web API中Action方法的返回值如果是普通数据类型,那么返回值就会默认被序列化为Json格式。

4、Web API中的Action方法的返回值同样支持IActionResult类型,不包含类型信息,因此Swagger等无法推断出类型,所以推荐用ActionResult,它支持类型转换,从而用起来更简单。

示例:

运行结果:

普通类型 序列化为格式

首先创建一个Person类

运行结果:

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

运行结果:

希望返回404

将返回值改为IActionResult

运行结果:

也可添加泛型

【总结:】

如果你的返回类型只有一种类型,那么直接使用哪一种类型得返回类型即可,若有多种则可以使用IAcitonResult

Asp.Net Core Web API Action 方法参数

add 方法使用[HTTPGET]默认的是querystring的方式传递

思考如何手动指定数据来自于querystring 还是路径还是来自请求体

捕捉URL占位符

1、在[HttpGet]、[HttpPost]等中使用占位符,比如[schoolName},捕捉路径中的内容,从而供Action方法的参数使用。

Students/GetAll/school/MIT/class/A001

HttpGet("school/schoolNamel/class (classNol")

2、捕捉的值会被自动赋值给Action中同名的参数如果名字不一致,可以用[FromRoute(Name="名字")]

3、演示混用

运行结果:

名字不同时:

运行结果:

HttpPost 方式

运行结果

捕捉QUERYSTRING的值

1、使用[FromQuery]来获取QueryString中的值。如果名字一致,只要为参数添加[FromQuery]即可;而如果名字不一致[FromQuery(Name = 名字)]。

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格式

复杂参数类型,可以用类的方式

请求方式相对应即可(2声明一个模型类和Json请求的格式一致即可)

混合使用

运行结果:

一定要设定请求头中的Content-Type为application/json,而且数据必须是合法的json格式

其他方式

Web API中很少用的方式:

1、从Content-Type为multipart/form-data的请求中获取数据的[FromForm]

2、从请求报文头中获取值的[FromHeader].




swagger的小问题,其实还是获取的浏览器端的 user_agent

相关推荐
BingoGo12 分钟前
TrueAsync Server 为 PHP 带来了原生的高性能 HTTP 服务器
后端·php
GISer_Jing13 分钟前
现代分布式系统架构全链路解析
后端·架构
我是一颗柠檬26 分钟前
【MySQL全面教学】MySQL聚合函数与分组Day5(2026年)
数据库·后端·mysql·database
星栈独行26 分钟前
别让 API 跳去登录页:我在 Axum 里做了认证失败双通道
前端·后端·rust·开源·github·个人开发
JaguarJack29 分钟前
TrueAsync Server 为 PHP 带来了原生的高性能 HTTP 服务器
后端·php
字节高级特工41 分钟前
Redis事务:简单但实用的打包执行
数据库·redis·后端·缓存
极客小云43 分钟前
【用 Go 写一个统一的 LLM Token 统计库:tokencalc 的设计与实现】
开发语言·后端·golang
Vect__1 小时前
C++转go的之路:变量声明、iota、函数、切片、init、defer
开发语言·后端·golang
fengxin_rou1 小时前
【SpringBoot+Elasticsearch 内容搜索系统实战】:架构设计与全流程实现
spring boot·后端·elasticsearch
还是鼠鼠2 小时前
AI掘金头条新闻系统 (Toutiao News)-用户注册-生成Token
后端·python·mysql·fastapi·web