SuperAPI AI 工具集

d1-03-swagger

编程与开发

查看项目

更新于 10-16 02:16

技能介绍

用途:该技能面向 up-api .NET 项目,用于为其添加 Swagger/OpenAPI 接口文档界面,并在完成后重新部署。它对应 CRUD 练习中“第 1 天 · 第 3 步 — Swagger”的任务,当用户要求执行 CRUD 练习第 1 天第 4 步,或要求添加 API 文档时使用。

主要能力:技能会先检查 up-api/Program.cs,因为较新的 dotnet new webapi 模板已经内置 OpenAPI 脚手架(AddOpenApi() / MapOpenApi())。如果用户明确需要 Swagger UI(而不仅仅是原始 OpenAPI JSON),则添加 Swashbuckle 包并配置 Swagger 中间件。

使用方式:在 up-api 目录下执行安装命令:

cd up-api dotnet add package Swashbuckle.AspNetCore

然后在 Program.cs 中添加以下代码:

builder.Services.AddEndpointsApiExplorer(); builder.Services.AddSwaggerGen(); // ... app.UseSwagger(); app.UseSwaggerUI();

适用场景:适用于 .NET Web API 项目需要生成可视化 API 文档界面的情况,尤其是教学或练习性质的 CRUD 项目。

限制:资料未提供该技能对 .NET 版本、项目结构或部署环境的具体要求;也未说明重新部署的具体步骤、目标平台或验证方式。是否必须使用 Swashbuckle 取决于项目是否已内置 OpenAPI 脚手架,资料建议先检查 Program.cs 再决定。