ASP.NET Core WebAPI_Controller简述

Mudrock__

已于 2024-07-16 15:31:34 修改

阅读量381

点赞数 9

于 2024-02-01 17:26:12 首次发布

本文链接：https://blog.csdn.net/Mudrock__/article/details/135977360

版权

ASP.NET Core WebAPI 专栏收录该内容

2 篇文章 0 订阅

订阅专栏

本文详细介绍了使用ASP.NETCore创建RESTfulAPI控制器的方法，包括GET、POST处理、路由规则以及如何处理不同类型的HTTP请求和参数绑定。

摘要由CSDN通过智能技术生成

详见代码注释

using Microsoft.AspNetCore.Mvc;
using WebAPI_1.POJO;

namespace WebAPI_1.Controllers
{
    // [controller]在URL中表现为Test 即controller类的前缀
    // [action]在URL中表现为HandleGet或HandlePost 即action函数的函数名
    // [Route("api/[controller]")] // 根据注解进行匹配(HttpGet HttpPost等等)
    [Route("api/[controller]/[action]")] // 优先根据action函数名进行匹配 当无法准确匹配时再根据注解进行匹配(HttpGet HttpPost等等)
    [ApiController]
    public class TestController : ControllerBase // controller类不继承ControllerBase类也能正常运行 只是无法调用ControllerBase类中的函数 但是相对地单元测试简单(配置环境简单)
    {
        [HttpGet]
        public string HandleGet(string message) // GET请求不能传递请求报文体(对象) 此处需通过变量接收数据 而无法通过对象接收数据(DELETE请求亦然)
                                                // [FromQuery(Name = "xxx")] 解决QueryString与形参不同名问题
        {
            return "GET: " + message;
        }
        [HttpGet]
        public IActionResult HandleGet2(int code) // 将函数声明为IActionResult可选择要返回的状态码(Ok:200 NotFound:404 BadRequest:400)
        {
            if (code == 200)
            {
                return Ok(new Param(code.ToString()));
            }
            else if (code == 404)
            {
                return NotFound(new Param(code.ToString()));
            }
            else
            {
                return BadRequest();
            }
        }
        [HttpGet("{param1}/{param2}/{param3}")] // 从URL取值
        public string HandleGet3(string param1, string param2, [FromRoute(Name = "param3")] string param) // [FromRoute(Name = "xxx")] 解决注释URL与形参不同名问题
        {
            return "param1:" + param1 + "|" + "param2:" + param2 + "|" + "param3:" + param;
        }

        [HttpPost]
        public string HandlePost(Param reqParam) // POST(PUT PATCH)请求可以
        {
            return "POST: " + reqParam.X;
        }

        // 函数修饰符为public但无注解则会导致swagger报错(public函数会被视作action函数进而导致报错 但报错归报错 并不影响正常接口的访问)
        // 修饰符若必需为public 则可通过[ApiExplorerSettings(IgnoreApi = true)]不将该函数视作action函数
        private void WriteMessage()
        {
            Console.WriteLine("message");
        }
    }
}