C# webapi添加Swagger

最新推荐文章于 2024-09-26 16:20:10 发布

太阳的后裔

最新推荐文章于 2024-09-26 16:20:10 发布

阅读量1.9k

点赞数 1

CC 4.0 BY-SA版权

分类专栏： webapi 文章标签： c# 开发语言后端

本文链接：https://blog.csdn.net/weixin_43942765/article/details/121317784

webapi 专栏收录该内容

1 篇文章

订阅专栏

本文档介绍了如何在.NET Core和.NET Framework应用中集成Swashbuckle，以展示Swagger页面，方便开发者查看API调用方法和数据。首先创建项目，然后通过NuGet下载并安装Swashbuckle.AspNetCore包。接着配置Swagger，设置版本信息，并在启动文件中启用Swagger及SwaggerUI。最后，修改启动URL以显示Swagger页面。整个过程简单易行，让API文档更加清晰易懂。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

webapi运行显示Swagger页面能让其他开发者更加清晰的看到调用的方法和数据
该过程.net core和framework框架都同样适用
1.创建
在这里插入图片描述

为什么我创建的是Myitem20211114最后变成小写首字母myitem20211114了呢？当然是因为小编早就创建好了小写的，大写的是小编后面重新创建的只不过为了给大家一个完整的过程

创建后运行默认的样子
在这里插入图片描述
2.下载安装包

在管理控台输入Install-Package Swashbuckle.AspNetCore -Version 5.0.0-re4，再点击enter键即可下载

3.配置

v1表示版本，1、2两处都要一样

services.AddSwaggerGen(m=> {
    m.SwaggerDoc("v1", new OpenApiInfo { Title = "myitem20211114",Version="v1" });
});

app.UseSwagger();

app.UseSwaggerUI(
    m => {
        m.SwaggerEndpoint("/swagger/v1/swagger.json","myitem20211114");
    }
    );

在这里插入图片描述
4.运行

将地址栏中的weatherforecast改为swagger/index.html

在这里插入图片描述
最后若改为默认运行就显示swagger页面，配置如下

将launchUrl地址改为swagger/index.html即可

在这里插入图片描述

A：“你什么时候最文静？”
B：“开学遇老师，操场遇男神，家中遇亲戚，路遇陌生人，其他时候都像脱缰了的哈士奇。”

在这里插入图片描述