c webapi传参

在C# Web API中，传参主要有以下几种方式：

一、通过URL查询字符串传参

1、基本使用

这种方式是在URL的路径后面以“?”开头，加上参数名和参数值，多个参数之间用“&”连接，访问一个获取用户信息的API接口时，可以这样写URL：“/api/users?userId=123&userName=John”，在Web API控制器的方法中，可以通过FromQuery属性来获取这些参数值。

示例代码如下：

“`csharp

[HttpGet]

[Route("api/users")]

public IActionResult GetUsers([FromQuery] int userId, [FromQuery] string userName)

{

// 根据userId和userName进行相应的业务逻辑处理，比如从数据库中查询用户信息

return Ok(new { userId = userId, userName = userName });

}

   这种方式适用于简单的参数传递，参数的值会显示在URL中，不太适合传递敏感信息，因为URL可能会被记录在浏览器历史记录或日志文件中。
2、可选参数
   如果某些参数是可选的，可以在方法参数类型后面添加“?”，如果userName参数是可选的，可以这样定义方法：
   ```csharp
     [HttpGet]
     [Route("api/users")]
     public IActionResult GetUsers([FromQuery] int userId, [FromQuery] string? userName = null)
     {
         if (userName != null)
         {
             // 处理有userName的情况
         }
         else
         {
             // 处理没有userName的情况
         }
         return Ok();
     }

二、通过路由传参

1、基本使用

路由参数是URL路径的一部分，通常用于标识资源的唯一性，对于获取特定ID的用户信息的接口，URL可以是“/api/users/{userId}”，{userId}”就是路由参数占位符，在控制器的方法中，可以通过FromRoute属性来获取这个参数值。

示例代码如下：

“`csharp

[HttpGet]

[Route("api/users/{userId}")]

public IActionResult GetUserById([FromRoute] int userId)

{

// 根据userId从数据库中查询用户信息并返回

return Ok(new { userId = userId });

}

   这种方式使URL更具可读性，也更符合RESTful风格的API设计原则。
2、复杂类型的路由参数
   如果需要传递复杂的对象作为路由参数，可以将对象的属性作为嵌套的路由参数，有一个表示订单的类Order，包含订单ID、产品ID和用户ID等属性，可以这样定义路由：“/api/orders/{orderId}/products/{productId}/users/{userId}”。
   然后在控制器方法中接收这些参数并进行相应的处理，不过要注意，复杂的路由参数可能会导致URL过长和难以理解，需要合理设计。
三、通过请求体传参
1、基本使用
   当需要传递大量的数据或者复杂的数据结构时，通常会将数据放在请求体中，请求体传参一般用于POST、PUT等请求方法，在C# Web API中，可以使用FromBody属性来获取请求体中的参数，常见的请求体格式有JSON、XML等，这里以JSON为例。
   有一个添加用户的接口，客户端发送一个包含用户信息的JSON对象作为请求体，在控制器中可以这样处理：
   ```csharp
     [HttpPost]
     [Route("api/users")]
     public IActionResult AddUser([FromBody] User user)
     {
         // 将user对象保存到数据库中
         return Ok(new { message = "User added successfully" });
     }

User是一个自定义的类，用于映射请求体中的JSON数据。

“`csharp

public class User

{

public int Id { get; set; }

public string Name { get; set; }

public string Email { get; set; }

}

2、模型绑定验证
   Web API会自动进行模型绑定验证，确保请求体中的数据能够正确地映射到模型对象中，如果数据不符合要求，会返回400 Bad Request错误，可以在模型类中使用数据注解来定义验证规则，
   ```csharp
     public class User
     {
         [Required]
         public int Id { get; set; }
         [Required]
         [StringLength(50)]
         public string Name { get; set; }
         [Required]
         [EmailAddress]
         public string Email { get; set; }
     }

这样，当客户端发送的请求体中缺少必要字段或者字段值不符合要求时，就会触发验证错误。

四、混合传参方式

1、常见场景

在实际开发中，经常会同时使用多种传参方式，在一个更新用户信息的接口中，可能会在URL中指定用户ID作为路由参数，同时在请求体中传递要更新的用户信息，这样可以清晰地区分资源的定位和具体的操作内容。

示例代码如下：

“`csharp

[HttpPut]

[Route("api/users/{userId}")]

public IActionResult UpdateUser([FromRoute] int userId, [FromBody] UserUpdateInfo updateInfo)

{

// 根据userId找到用户，然后用updateInfo中的数据更新用户信息

return Ok(new { message = "User updated successfully" });

}

   UserUpdateInfo是另一个自定义的类，包含要更新的字段：
   ```csharp
     public class UserUpdateInfo
     {
         public string Name { get; set; }
         public string Email { get; set; }
     }

2、注意事项

在使用混合传参方式时，要注意参数的顺序和命名，避免混淆，要确保客户端正确地按照接口要求传递参数，否则可能会导致服务器端无法正确解析参数或者出现错误。

C# Web API提供了多种灵活的传参方式，开发者可以根据实际需求选择合适的传参方式来实现高效的数据传输和交互，无论是简单查询还是复杂操作，都能找到合适的方法来满足需求，从而构建出功能强大、易于维护的Web API服务。