ProducesResponseType的作用

最新推荐文章于 2023-11-07 15:03:28 发布
最新推荐文章于 2023-11-07 15:03:28 发布
阅读量2.9k 收藏 3
点赞数 2
分类专栏： .netCore 文章标签： c#
原文链接：https://www.cnblogs.com/xihao/p/13497271.html
版权

当我们写的接口已IActionResult为返回类型的时候，我们会发现swagger的Responses下并没有为我们生成返回信息描述，因为它并不知道我们具体要返回的是什么形式的数据

　　例如，我们新写一个分页接口：

　　

    

 　　我们可以看到没有任何的返回信息描述，那怎么办呢？这里我们就要用到swagger的ProducesResponseType特性来告诉swagger我们的返回结构

　　

 　　再次启动调试，我们发现在Responses这一模块已经正确显示了我们的PageList描述信息。

　　细心的可能会发现我们在使用ProducesResponseType的时候除了给了它一个type，还给了一个200，这是啥意思呢？

　　这个200的意思就是响应状态200的时候我给你返回这么一个结构的数据，那是不是说我们可以定义不同响应状态不同数据结构呢？答案是肯定的。ProducesResponseType是可以多次标记的，你只需要为其他状态按照上边的方式添加返回结构标记即可

josjonah
关注
  • 2
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Response 用法集合
12-26
收集了五種response方法 傳參 亂碼等問題
.net core6.0swagger注入demo
05-16
同时，可以使用`[ProducesResponseType]`或`[ProducesResponseType(typeof(MyResponseType))]`来指定可能的返回类型和状态码。 例如： ```csharp [ApiController] [Route("[controller]")] public class ...
Web API 约定
qq_35624605的博客
04-29 251
Web API 约定 默认的约定 集将应用于 ContactsConventionController 中的所有操作： [ApiController] [ApiConventionType(typeof(DefaultApiConventions))] [Route("api/[controller]")] public class ContactsConventionController : C...
@RequestMapping中的produces的作用和使用方式
qq_40559984的博客
09-09 3908
1.他的作用是指定返回值类型和返回值编码 2.consumes：指定处理请求的提交内容类型（Content-Type），例如application/json, text/html; 一、produces的例子 produces第一种使用，返回json数据，下边的代码可以省略produces属性，因为我们已经使用了注解@responseBody就是返回值是json数据： 1 @Controller 2 @RequestMapping(value = "/pets/{petId}", metho.
Axios的不同responseType的使用场景
最新发布
weixin_40243502的博客
11-07 1245
应用场景：用于将响应数据解析为 JSON 对象，适用于REST API和Web服务的调用。应用场景：用于接收二进制数据，通常是文件下载或处理图片、音频、视频等二进制数据的情况。应用场景：用于将响应数据解析为 HTML 文档对象，适用于获取和操作HTML文档的情况。应用场景：用于处理响应数据流，适用于大文件下载或需要逐行处理数据的情况。应用场景：用于将响应数据解析为纯文本，适用于文本内容的获取。类似，用于接收二进制数据，但通常用于文件下载等场景。一、arraybuffer。三、document。
swagger java_Swagger实现API文档功能
weixin_42568801的博客
02-19 451
介绍：wagger也称为Open API，Swagger从API文档中手动完成工作，并提供一系列用于生成，可视化和维护API文档的解决方案。简单的说就是一款让你更好的书写API文档的框架。我们为什么选择swagger，现在的网站开发结果越来越注重前后端的分离，比如以前的webFrom到现在的mvc模式都是为了这个前后端的分离。就算再如何的分离实现，也是不可避免的要进行数据交互的，那么接口的重要性就...
Swagger学习例子
01-23
在方法上，我们可以使用Swagger的特性（如 `[ProducesResponseType]` 和 `[FromQuery]`）来进一步注解和描述API的行为和参数。 例如： ```csharp [HttpGet] [Route("api/[controller]")] [ProducesResponseType...
webapi 资料
07-24
[ProducesResponseType(StatusCodes.Status200OK)] public ActionResult<string> Get(int id) { return "value"; } } ``` 在Swagger UI中，用户可以看到清晰的API列表，每个操作都有详细的描述、参数、示例...
RCN.API:在> ASP.NET CORE中进行REST API学习
04-11
[ProducesResponseType(StatusCodes.Status400BadRequest)] public ActionResult<Product> Create([FromBody] Product product) { if (!ModelState.IsValid) return BadRequest(ModelState); // 保存产品到...
MVCToSwagger
12-21
[ProducesResponseType(typeof(List), StatusCodes.Status200OK)] public IActionResult GetUsers() { // 获取并返回用户列表 } } ``` 这里，`User`是一个自定义的数据模型类，它定义了响应数据的结构。 在...
response的contentType 几种类型
zxfly6的博客
07-24 2306
引言： 在Http请求中，我们每天都在使用Content-type来指定不同格式的请求信息，但是却很少有人去全面了解content-type中允许的值有多少，这里将讲解Content-Type的可用值，以及在spring MVC中如何使用它们来映射请求信息。 1.  Content-Type   MediaType，即是Internet Media Type，互联网媒体类型；也叫做MIME类型...
ASP.NET Core WebApi使用Swagger生成api说明文档看这篇就够了
依乐祝的博客
06-28 4698
&#13; 引言 在使用asp.net core 进行api开发完成后，书写api说明文档对于程序员来说想必是件很痛苦的事情吧，但文档又必须写，而且文档的格式如果没有具体要求的话，最终完成的文档则完全取决于开发者的心情。或者详细点，或者简单点。那么有没有一种快速有效的方法来构建api说明文档呢？答案是肯定的， Swagger就是最受欢迎的REST APIs文档生成工具之一！...
HttpServletResponse通过setContentType设置响应头失败，以及解决办法
码海拾贝
10-12 6735
1 背景 1.1 版本信息 springcloud版本：Dalston.SR1 springboot版本：1.5.3.Release JDK版本：1.8 1.2 缺陷描述 当我从Controller或者ControllerAdvice直接返回一个JSON字符串时，通过response.setContentType("application/json;charset=UTF-8");失败，前端实际拿到的content-type为text/plain;charset=UTF-8.如果前端对头部有校验的话，很
produces在@requestMapping中的使用方式和作用
ZhangYaohui专栏
06-25 1337
转载自：https://blog.csdn.net/jaryle/article/details/72965885 produces可能不算一个注解，因为什么呢，它是注解@requestMapping注解里面的属性项， 它的作用是指定返回值类型，不但可以设置返回值类型还可以设定返回值的字符编码； 还有一个属性与其对应，就是consumes： 指定处理请求的提交内容类型（Content-Typ...
【小5聊】C#基础之Response.ContentType响应内容类型
小5聊的博客
01-04 4679
Response.ContentType 1、文本格式：html、xml、txt Response.ContentType = "text/html "; Response.ContentType = "text/xml"; Response.ContentType = "text/plain"; 2、图片格式 Response.ContentType = "image/jpg"; ...
.NET CORE中ProducesResponseType的用法
06-08
[ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] public IActionResult MyApiMethod() { // API method logic here } ``` 上面的代码中，我们使用...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值