杨中科 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

相关推荐
短剑重铸之日1 小时前
《设计模式》第七篇:适配器模式
java·后端·设计模式·适配器模式
树码小子3 小时前
SpringIoC & DI (1):IOC介绍 & Spring IoC使用 & DI
java·后端·spring
墨染青竹梦悠然4 小时前
基于Django+vue的图书借阅管理系统
前端·vue.js·后端·python·django·毕业设计·毕设
怪兽毕设4 小时前
基于Django的洗衣服务平台设计与实现
后端·python·django·洗衣服务平台
奥特曼打小白4 小时前
Microsoft SQL Server2025的下载、安装与配置——从环境、管理工具、配置管理器入手,解决VS2022ASP.NET网站项目中SqlDataSource控件找不到服务器的问题
sqlserver·asp.net
程序员泠零澪回家种桔子5 小时前
微服务日志治理:ELK 栈实战指南
后端·elk·微服务·云原生·架构
qq_12498707535 小时前
基于html的书城阅读器系统的设计与实现(源码+论文+部署+安装)
前端·vue.js·spring boot·后端·mysql·信息可视化·html
CodeToGym5 小时前
【全栈进阶】Spring Boot 整合 WebSocket 实战:从实时告警到金融行情推送
java·后端·spring
Leinwin5 小时前
Moltbot 部署至 Azure Web App 完整指南:从本地到云端的安全高效跃迁
后端·python·flask
毕设源码-邱学长5 小时前
【开题答辩全过程】以 基于Springboot个人健康运动系统的设计与实现为例,包含答辩的问题和答案
java·spring boot·后端