.net core 使用swagger生成API文档

Posted mobaiyu

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了.net core 使用swagger生成API文档相关的知识,希望对你有一定的参考价值。

【1】安装Swashbuckle.AspNetCore包

【2】在Startup.cs中注册swagger

//注册Swagger生成器,定义一个和多个Swagger 文档
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new Info { Title = "爱住微订API", Version = "v1" });
});

【3】在Startup.cs中配置swagger

 app.UseSwagger();
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "爱住微订API V1");
                c.RoutePrefix = string.Empty;//设置后直接输入IP就可以进入接口文档
            });

【4】在launchSettings.json中修改启动地址

"launchUrl": "swagger",

  

以上是关于.net core 使用swagger生成API文档的主要内容,如果未能解决你的问题,请参考以下文章

C#(.Net Core WebAPI)之API文档的生成(Swagger)

[Asp.Net Core]ASP.NET Core WebApi使用Swagger生成api说明文档看这篇就够了

asp.net core web api 生成 swagger 文档

asp.net core web api 生成 swagger 文档

用Swashbuckle给ASP.NET Core的项目自动生成Swagger的API帮助文档

ASP.NET Core Web API使用静态swagger.json文件