.NET MVC API Swagger 自动生成API文档入坑

开发环境 Win10 VS2022 .NET8.0

1.从NuGet添加Swagger

在解决方案资源管理器中右键单击项目>管理 NuGet 包

将包源设置为"nuget.org"

确保启用"包括预发行"选项

在搜索框中输入"Swashbuckle.AspNetCore"

从"浏览"选项卡中选择最新的"Swashbuckle.AspNetCore"包,然后单击"安装"

2.将 Swagger 生成器添加到以下位置的服务集合中Program.cs:
复制代码
builder.Services.AddControllers();

builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

启用中间件 生成

复制代码
app.UseSwagger();
app.UseSwaggerUI();

app.UseSwaggerUI(options =>
{
    options.SwaggerEndpoint("/swagger/v1/swagger.json", "v1");
    options.RoutePrefix = string.Empty;
});
3.添加API控制器

创建api

复制代码
        // GET api/<myapi>/5
        /// <summary>
        /// getid
        /// </summary>
        /// <param name="id">id参数</param>
        /// <returns>valuestr</returns>
        [HttpGet("{id}")]
        public string Get(int id)
        {
            return "value" + id;
        }

        // POST api/<myapi>
        [HttpPost]
        public string Post([FromBody] string value)
        {
            //post逻辑代码
            return "myPost";
        }

        // PUT api/<myapi>/5
        [HttpPut("{id}")]
        public string Put(int id, [FromBody] string value)
        {
            //put逻辑代码
            return "myPut";
        }

        // DELETE api/<myapi>/5
        [HttpDelete("{id}")]
        public string Delete(int id)
        {
            //delete逻辑代码
            return "myDelete";
        }
4.F5运行 访问/swagger/index.html

5.try it out测试API

看到返回了 value111 即接口没问题

参考资料:

asp.net core - Swagger UI Authorization using IdentityServer4 returns Invalid redirect_uri - Stack Overflow
c# - What is AddEndpointsApiExplorer in ASP.NET Core 6 - Stack Overflow

Get started with Swashbuckle and ASP.NET Core | Microsoft Learn

Swagger 基础

相关推荐
喵叔哟9 小时前
9. 从0到上线:.NET 8 + ML.NET LTR 智能类目匹配实战--Web API 接口与前端集成:把能力对外开放
前端·.net
唐青枫11 小时前
C#.NET PeriodicTimer 深入解析:高效异步定时器的正确打开方式
c#·.net
@LetsTGBot搜索引擎机器人12 小时前
Telegram 被封是什么原因?如何解决?(附 @letstgbot 搜索引擎重连技巧)
开发语言·python·搜索引擎·机器人·.net
追逐时光者1 天前
C#/.NET/.NET Core技术前沿周刊 | 第 59 期(2025年10.20-10.26)
后端·.net
喵叔哟1 天前
8. 从0到上线:.NET 8 + ML.NET LTR 智能类目匹配实战--规则回退与可解释性:四层策略如何兜底
人工智能·深度学习·.net
宝桥南山1 天前
.NET - .NET Aspire的Command-Line和GitHub Copilot
microsoft·微软·c#·asp.net·.net·.netcore
我是唐青枫1 天前
C#.NET SqlKata 使用详解:优雅构建动态 SQL 查询
sql·c#·.net
唐青枫1 天前
C#.NET NCrontab 深入解析:轻量级 Cron 表达式解析器
c#·.net
追逐时光者2 天前
一个基于 .NET 8 + Vue3 实现的极简 RABC 权限管理系统
后端·.net
.NET修仙日记2 天前
C#/.NET 微服务架构:从入门到精通的完整学习路线
微服务·c#·.net·.net core·分布式架构·技术进阶