首页 > 其他分享 >.NET API 中的 FromRoute、FromQuery、FromBody 用法

.NET API 中的 FromRoute、FromQuery、FromBody 用法

时间:2023-08-28 23:34:06浏览次数:42  
标签:传参 body Task FromRoute route FromBody API Parameter public

原文链接:https://www.cnblogs.com/ysmc/p/17663663.html

  最近技术交流群里,还有不少小伙伴不知道 FromRoute、FromQuery、FromBody 这几个特性是怎么使用的,也不清楚它们之间的区别在哪里,特意写下这个文章,希望可以帮助到迷茫的小伙伴。

在API开发过程中,我们先要确定我们的接口是干嘛的,获取请求数据用 GET,上传使用 POST,修改使用 PATCH,删除是 DELETE,通常使用这4个就足够了。

  接着下一步,就是参数放在哪了,通常:

  (1)GET请求的参数,是以url?xxx=value1&xxx=value 这样的方式进行传参;

  (2)POST、PATCH,则是放在 body里,当然也可以放在form中;

  (3)而所有的请求方式,都是支持通过 url 传参的,包括通过 route 传参;

  好久没写文档了,都不知道怎么写了,还是直接上代码吧;

  我们新建一个API工程,过程我就不演示了;建一个Controller,我这里起名为 MethodsController;还需要建一个接收参数的实体类,当然也可以不使用实体类,个人建议是使用;

实体类

public class Parameter
{
    public string? Method { get; set; }

    public string? Value { get; set; }
}

Url 传参

[HttpGet]
public async Task<Parameter> GetQueryAsync([FromQuery] Parameter query)
{
    return await Task.FromResult(query);
}

示例

Route 传参

[HttpGet("{method}/{value}")]
public async Task<Parameter> GetRouteAsync([FromRoute] Parameter route)
{
    return await Task.FromResult(route);
}

示例

Body传参

[HttpPost]
public async Task<Parameter> PostAsync([FromBody] Parameter body)
{
    return await Task.FromResult(body);
}

示例

 混合

[HttpPatch("{method}/{value}")]
public async Task<Dictionary<string, Parameter>> PatchAsync(
    [FromRoute] Parameter route,
    [FromQuery] Parameter query,
    [FromBody] Parameter body)
{
    var result = new Dictionary<string, Parameter>()
    {
        ["route"] = route,
        ["query"] = query,
        ["body"] = body
    };

    return await Task.FromResult(result);
}

示例

   写得不好,手生了,大家有什么想了解的欢迎在评论区留言,我也需要多练练手【手动狗头】,什么时候博客园可以加个表情功能啊!

标签:传参,body,Task,FromRoute,route,FromBody,API,Parameter,public
From: https://www.cnblogs.com/ysmc/p/17663663.html

相关文章

  • Windows服务作为Web API的服务端
    将Windows服务作为WebAPI的服务端,需要实现一个WebAPI控制器,并将其集成到Windows服务中。以下是一些基本步骤:在您的Windows服务项目中创建一个新的WebAPI控制器。您可以使用VisualStudio的类库模板来创建一个空的WebAPI项目,然后将控制器添加到该项目中。实现WebAPI控制器......
  • 实验3:媒体API之口述校史
    一、实验目标掌握视频API的操作方法;掌握如何发送随机颜色的弹幕。二、实验步骤根据实验手册上的网址,下载视频播放图标,图片如下。进入微信开发者工具,创建一个新项目videoDemo。在根目录下的app.json中定义导航栏标题和背景颜色,如下图所示。根据实验文档,页面设......
  • Python查询Prometheus API
     #!/bin/python#-*-coding:utf-8-*-importpandasaspdimportrequests,time,redefgetcolumn(status):iffloat(status)<80:return"正常"#eliffloat(status)<2:#return"异常"else:......
  • 如何将低代码平台的用户输入作为 API 输入参数
    要将低代码平台上的用户输入作为API输入参数,你需要确保你的平台能够处理API调用,并且可以获取和处理用户的输入。以下是一种可能的步骤:用户输入:首先,你需要在你的低代码平台上创建一个用户输入表单,用户可以在这里输入他们的数据。捕获输入:在用户提交表单后,你的平台需要有能力......
  • 在低代码平台执行 API 请求并将结果显示在页面上
    低代码开发平台(Low-CodeDevelopmentPlatform)是一种用于构建应用程序的软件开发环境,它允许开发者通过图形化的方式,而非传统的手动编码方式来创建应用程序。这种方式大大减少了开发应用程序所需的代码量,因此称为低代码。低代码平台的核心是其拖放式的用户界面,这允许开发者通过直......
  • .net core Api获取所有Action以及注释内容
    有个项目需要获取项目内所有Action,并在凌晨定时任务跑完所有接口检查是否有接口报错,写了如下方法:///<summary>///获取Action注释///</summary>///<paramname="root"></param>///<paramname="method">方法</para......
  • python+playwright 学习-77 playwright 发送接口请求APIRequestContext
    前言每个Playwright浏览器上下文都有与其关联的APIRequestContext实例,该实例与浏览器上下文共享cookie存储,可以通过browser_context.request或page.request访问。也可以通过调用api_request.new_context()手动创建一个新的APIRequest上下文实例。通过浏览器发请求可以通过browser......
  • 为什么 OpenAI 的 API 对于非英语语言来说更昂贵
    短语“Helloworld”怎么可能有两个英语令牌和12个印地语令牌?在我最近发表了一篇关于如何估算OpenAI的API成本的文章后,我收到了一条有趣的评论,有人注意到OpenAIAPI在其他语言中比在英语中贵得多,例如使用中文,日语或韩语(CJK)字符的语言。一位读者对我最近关于如何使用库估算Ope......
  • java与es8实战之三:Java API Client有关的知识点串讲
    欢迎访问我的GitHub这里分类和汇总了欣宸的全部原创(含配套源码):https://github.com/zq2599/blog_demos本篇概览本篇是《java与es8实战》系列的第三篇,将一些重要的知识点在这里梳理清楚,为后面的实践奠定基础一共有七个与JavaAPIClient有关的重要知识点关于namespace:每......
  • Windows实时绘图:2D绘图和3D绘图所用的API有何不同?
    3D绘图众所周知的有OpenGL、WebGL等。2D绘图有GDI、GDI+。它们在进行数据渲染方面有何区别?2D图形渲染不需要3D渲染上的一些坐标转换,但是二维转换还是要的。进行渲染时,也要有渲染管线->生成图片。ArcMap绘图用的是哪个图形接口?QGIS用的是哪个图形接口?GeoTools渲染地图时又是......