Asp.Net Core使用swagger生成api文档的完整步骤
41 浏览量
2020-10-15
22:31:51
上传
评论
收藏 56KB PDF 举报
Asp.Net Core使用使用swagger生成生成api文档的完整步骤文档的完整步骤
主要给大家介绍了关于Asp.Net Core使用swagger生成api文档的完整步骤，文中通过示例代码介绍的非常详
细，对大家学习或者使用Asp.Net Core具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
前言前言
.Net Core中有两个集成NSwag的包，分别为Swashbuckle和NSwag。两者的配置大同小异。这里以NSwag为例。
一、前期准备一、前期准备
1、初始化、初始化asp.net core 测试项目测试项目
新建asp.net core项目，此处略过；
新建apicontroller，并编写测试代码；
[Route("api/[controller]")]
[ApiController]
public class UserApiController : ControllerBase
{
/// <summary>
/// 获取用户信息，根据用户id
/// </summary>
/// <param name="id">用户id</param>
/// <returns></returns>
[HttpGet("getuser/{id}")]
public ActionResult GetUser(int id)
{
User u = new User { Id=1,Name="Jack"};
return Ok(new { ok = true, data = u });
}
/// <summary>
/// 添加用户
/// </summary>
/// <param name="user">用户信息</param>
/// <returns></returns>
[HttpPost("postuser")]
public ActionResult AddUser([FromBody]User user)
{
return Ok(new { ok = true, data = user });
}
}
public class User
{
/// <summary>
/// 用户id
/// </summary>
public int Id { get; set; }
/// <summary>
/// 用户姓名
/// </summary>
public string Name { get; set; }
}
2、使用、使用nuget安装安装 NSwag.AspNetCore
方式一：通过vs图形界面安装；
方式二：通过nuget 命令安装：
Install-Package NSwag.AspNetCore
二、配置二、配置Swagger
1、添加并配置、添加并配置 Swagger 中间件中间件
在应用的Startup类中的ConfigureServices 方法中，注册所需的 Swagger 服务：
public void ConfigureServices(IServiceCollection services)
{
services.AddControllersWithViews();
资源评论
