asp.net core中使用swagger

 (1)通过nuget引入swag

 (2)代码中处理

 

var builder = WebApplication.CreateBuilder(args);
// Add services to the container.

builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

var app = builder.Build();

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

app.UseHttpsRedirection();

app.UseAuthorization();

app.MapControllers();

app.Run();

(3)配置

 

 

 这个路径下找不到v1/swagger.json,需要进行配置

 (4)Swagger中的接口添加注释

.net项目只要在生成->输出中勾选了文档文件,就会对注释生成相应的文档。

 

 

 

 

实际项目中是这样使用的:

把读取的XML路径放置Json 文件中。在Startup 中进行引用:如下图所示:

 

 有关路径小注意的有两点:

  1):在本地运行是代表的是项目文件所在盘的根路径,

  2):当我们运行在IIS的时候,此路径代表的是,Web项目的根路径。

 在Startup中使用如下图:

参考文档

asp.net core中使用swagger

posted @ 2025-03-19 15:07  头号程序媛  阅读(47)  评论(0)    收藏  举报