在Web API项目中,用Swagger编程语句描述接口的例子?
时间: 2023-06-24 15:04:10 浏览: 201
Swagger API接口创建
以下是一个使用Swagger描述接口的例子:
```csharp
/// <summary>
/// 获取用户信息
/// </summary>
/// <param name="id">用户ID</param>
/// <returns>用户信息</returns>
[HttpGet("{id}")]
[ProducesResponseType(typeof(UserInfo), StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public IActionResult GetUser(int id)
{
var user = _userService.GetUser(id);
if (user == null)
{
return NotFound();
}
return Ok(user);
}
```
上面的代码描述了一个获取用户信息的接口。使用`HttpGet`特性指定了HTTP请求方法为GET,使用`ProducesResponseType`特性指定了接口返回的数据类型和HTTP响应码。使用XML注释描述了接口的功能,参数和返回值。Swagger会根据这些信息生成API文档和测试工具。
阅读全文