使用Swagger生成api文档

1.新建net core webapi项目

2.在nuget中搜索安装Swashbuckle.AspNetCore包(注意：是选第一个)

 

 3.在Startup.cs中添加如下代码

services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" });
});
View Code

 

1 app.UseSwagger();
2 app.UseSwaggerUI(s =>
3 {
4     s.SwaggerEndpoint("/swagger/v1/swagger.json", "My API version 1.0");//注意,中间那段的名字 (v1) 要和 上面 SwaggerDoc 方法定义的 名字 (v1)一样
5     s.RoutePrefix = string.Empty; //默认值是 "swagger" 
6 });
View Code

 4.在api文档中显示注释

 API 项目属性->生成：输出 勾选"XML文档文件"

 

 

  在 ConfigureServices  方法中指定xml文档路径

c.IncludeXmlComments(System.IO.Path.Combine(Microsoft.DotNet.PlatformAbstractions.ApplicationEnvironment.ApplicationBasePath, "webapi.xml"), true);
posted @ 2019-09-11 11:28  weston43  阅读(803)  评论(0)  编辑  收藏  举报