在ASP.Net Core Web API中使用Swagger

一、创建ASP.Net Core Web API项目

1、在Visual Studio 2019中创建新项目,并选择Web模板中的“ASP.Net Core Web应用程序”。

2、在“配置新项目”对话框中输入项目名称、位置等信息。

3、选择应用程序框架(.Net Core)和版本(ASP.Net Core 3.1),选择应用程序模板(API)。为了简单起见,取消选中“高级”选项中的“为HTTPS配置”项。

二、Swagger配置

1、使用NuGet安装Swagger包(Swashbuckle.AspNetCore)

1.1 在VS2019的“工具”菜单栏中选择“NuGet 包管理器”,在右侧菜单中点击“管理解决方案的 NuGet 程序包”。

1.2 在弹出的“NuGet 解决方案”的“浏览”选项卡中输入Swashbuckle.AspNetCore,在输出列表中选择对应的包后安装。

2、在Startup类中注册Swagger服务

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
public void ConfigureServices(IServiceCollection services)
{
    //添加Swagger生成器
    services.AddSwaggerGen(options =>
    {
        //添加Swagger文档
        options.SwaggerDoc("V1", new OpenApiInfo()
        {
            Title = "test", //标题
            Version = "version-01", //版本
            Description = "ASP.Net Core Web API Swagger test" //描述
        });
    });
 
    services.AddControllers();
}

3、中间件中使用Swagger

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }
 
    //启用Swagger中间件
    app.UseSwagger();
    app.UseSwaggerUI(options =>
    {
        //设置Swagger文档路径
        options.SwaggerEndpoint("/swagger/V1/swagger.json", "swagger test");
    });
 
    app.UseRouting();
 
    app.UseAuthorization();
 
    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();
    });
}

三、运行项目

运行项目,在浏览器中输入http://localhost:52685/swagger/index.html,出现API文档页面。

四、总结

使用Swagger可以归纳为3个步骤:

1、安装Swagger包(Swashbuckle.AspNetCore)

2、注册Swagger服务

1
2
3
4
5
6
7
8
9
10
11
//添加Swagger生成器
services.AddSwaggerGen(options =>
{
    //添加Swagger文档
    options.SwaggerDoc("V1", new OpenApiInfo()
    {
        Title = "test", //标题
        Version = "version-01", //版本
        Description = "ASP.Net Core Web API Swagger test" //描述
    });
});

3、在中间件中使用Swagger

1
2
3
4
5
6
7
//启用Swagger中间件
app.UseSwagger();
app.UseSwaggerUI(options =>
{
    //设置Swagger文档路径
    options.SwaggerEndpoint("/swagger/V1/swagger.json", "swagger test");
});
posted @   xhubobo  阅读(343)  评论(0编辑  收藏  举报
编辑推荐:
· 没有源码,如何修改代码逻辑?
· 一个奇形怪状的面试题:Bean中的CHM要不要加volatile?
· [.NET]调用本地 Deepseek 模型
· 一个费力不讨好的项目,让我损失了近一半的绩效!
· .NET Core 托管堆内存泄露/CPU异常的常见思路
阅读排行:
· DeepSeek “源神”启动!「GitHub 热点速览」
· 微软正式发布.NET 10 Preview 1:开启下一代开发框架新篇章
· C# 集成 DeepSeek 模型实现 AI 私有化(本地部署与 API 调用教程)
· DeepSeek R1 简明指南:架构、训练、本地部署及硬件要求
· NetPad:一个.NET开源、跨平台的C#编辑器
点击右上角即可分享
微信分享提示