.NET Core和Swagger 生成 Api 文档

1 nuget  添加  Swashbuckle.AspNetCore

2 修改startup.cs文件

命名空间

using Swashbuckle.AspNetCore.Swagger;

ConfigureServices方法加入AddSwaggerGen:

//Inject Swagger services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new Info { Title = "MyApi", Version = "v1" }); // Set the comments path for the Swagger JSON and UI. var xmlPath = Path.Combine(AppContext.BaseDirectory, "项目名称.XML"); c.IncludeXmlComments(xmlPath); });

Configure方法加入，允许Swagger提供服务生成json文档以及UI：

app.UseSwagger().UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1"); });

3 

3.设置XML注释在 Visual Studio 中右击项目并且选择 属性在 生成 区域下面勾选 XML文档文件 。

填入 项目名称.XML

4 给 api添加注释

/// <summary>

/// Put value by id and value

/// </summary>

/// <param name="id">id</param>

/// <param name="value">value</param>

5 生成 json文件

在浏览器中输入：http://localhost:端口/swagger/v1/swagger.json

显示json内容

6.在浏览器输入：http://localhost:9040/swagger/ 

转载于:https://www.cnblogs.com/simadi/p/11393854.html

相关资源：Asp.Net Core使用swagger生成api文档的完整步骤