.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 基础

相关推荐
Jeff-Tsai11 小时前
Day 24:权限的三轴:动作、行与列
.net·架构设计·erp·definition-driven
BruceNeter11 小时前
C# winform卡死问题分析1——线程池子线程创建句柄
c#·.net
Jeff-Tsai1 天前
Day 23:API Payload 安全管道:顺序、保护等级与密钥
.net·架构设计·erp·definition-driven
IT规划师2 天前
Redis 核心机制 | 内存淘汰策略全解:8种策略、近似LRU采样、LFU计数器
redis·.net
Jeff-Tsai2 天前
Day 22:XML、JSON 与 MessagePack 的分工
.net·架构设计·erp·definition-driven
风云3 天前
从 NLite 到 Vane.Container 1.0:压箱十六年的自研 DI 容器开源
.net·di·mini 容器·nlite
Jeff-Tsai4 天前
Day 21:业务逻辑定制与 Plugin 的四个时点
.net·架构设计·erp·definition-driven
IT规划师4 天前
Redis 核心机制 | 键生命周期与 TTL 管理
redis·.net