宜宾网站建设公司

怎么在Asp.NetCore中使用swagger生成一个api文档-创新互联

本篇文章为大家展示了怎么在Asp.Net Core中使用swagger生成一个api文档，内容简明扼要并且容易理解，绝对能使你眼前一亮，通过这篇文章的详细介绍希望你能有所收获。

创新互联-专业网站定制、快速模板网站建设、高性价比华安网站开发、企业建站全套包干低至880元,成熟完善的模板库,直接使用。一站式华安网站制作公司更省心,省钱,快速模板网站建设找我们，业务覆盖华安地区。费用合理售后完善，十余年实体公司更值得信赖。

一、前期准备


1、初始化asp.net core 测试项目


新建asp.net core项目，此处略过；


新建apicontroller，并编写测试代码；

 [Route("api/[controller]")]
 [ApiController]
 public class UserApiController : ControllerBase
 {
 /// 
 /// 获取用户信息，根据用户id
 /// 
 /// 用户id
 /// 
 [HttpGet("getuser/{id}")]
 public ActionResult GetUser(int id)
 {
  User u = new User { Id=1,Name="Jack"};
  return Ok(new { ok = true, data = u });
 }
 /// 
 /// 添加用户
 /// 
 /// 用户信息
 /// 
 [HttpPost("postuser")]
 public ActionResult AddUser([FromBody]User user)
 {
  return Ok(new { ok = true, data = user });
 }
 }
 public class User
 { 
 /// 
 /// 用户id
 /// 
 public int Id { get; set; }
 /// 
 /// 用户姓名
 /// 
 public string Name { get; set; }
 }

2、使用nuget安装 NSwag.AspNetCore


方式一：通过vs图形界面安装；


怎么在Asp.Net Core中使用swagger生成一个api文档


方式二：通过nuget 命令安装：

Install-Package NSwag.AspNetCore

怎么在Asp.Net Core中使用swagger生成一个api文档

二、配置Swagger


1、添加并配置 Swagger 中间件


在应用的Startup类中的ConfigureServices 方法中，注册所需的 Swagger 服务：


  public void ConfigureServices(IServiceCollection services)
  {
   services.AddControllersWithViews();
   
   // Register the Swagger services
   services.AddSwaggerDocument()
  }

在 Startup类中的Configure 方法中，启用中间件为生成的 Swagger 规范和 Swagger UI 提供服务：


public void Configure(IApplicationBuilder app)
{
 app.UseStaticFiles();

 // Register the Swagger generator and the Swagger UI middlewares
 app.UseOpenApi();
 app.UseSwaggerUi3();

 app.UseMvc();
}

启动应用。 转到：


http://localhost:/swagger，以查看 Swagger UI。


http://localhost:/swagger/v1/swagger.json，以查看 Swagger 规范。


怎么在Asp.Net Core中使用swagger生成一个api文档

2、自定义 API 文档


API 信息和说明


在 Startup.ConfigureServices 方法中，传递给 AddSwaggerDocument 方法的配置操作会添加诸如作者、许可证和说明的信息：

  public void ConfigureServices(IServiceCollection services)
  {
   //services.AddControllers();
   services.AddControllersWithViews();

   services.AddSwaggerDocument(config =>
   {
    config.PostProcess = document =>
    {
     document.Info.Version = "v1";
     document.Info.Title = "UserManageApp API";
     document.Info.Description = "A simple ASP.NET Core web API";
     document.Info.TermsOfService = "None";
     document.Info.Contact = new NSwag.OpenApiContact
     {
      Name = "张三",
      Email = string.Empty,
      Url = "https://example.com"
     };
     document.Info.License = new NSwag.OpenApiLicense
     {
      Name = "Use under LICX",
      Url = "https://example.com/license"
     };
    };
   });
  }

Swagger UI 显示版本的信息：


怎么在Asp.Net Core中使用swagger生成一个api文档

XML 注释


若要启用 XML 注释，请执行以下步骤：


以windows先使用vs为例：

  • 在“解决方案资源管理器”中右键单击该项目，然后选择“编辑 .csproj” 。

  • 手动将突出显示的行添加到 .csproj 文件 ：

怎么在Asp.Net Core中使用swagger生成一个api文档

上述内容就是怎么在Asp.Net Core中使用swagger生成一个api文档，你们学到知识或技能了吗？如果还想学到更多技能或者丰富自己的知识储备，欢迎关注创新互联行业资讯频道。


当前标题：怎么在Asp.NetCore中使用swagger生成一个api文档-创新互联
文章URL：http://ybzwz.com/article/cosjdg.html

其他资讯