asp.net core配置swagger

最新推荐文章于 2024-12-11 08:49:42 发布

lxc1990425

最新推荐文章于 2024-12-11 08:49:42 发布

阅读量2.4k

点赞数

CC 4.0 BY-SA版权

分类专栏： asp.net core

本文链接：https://blog.youkuaiyun.com/lxc1990425/article/details/79162612

asp.net core 专栏收录该内容

3 篇文章

订阅专栏

本文介绍如何在ASP.NET Core Web API项目中集成Swagger，实现API文档自动生成及在线测试功能。通过NuGet安装Swashbuckle.AspNetCore包，并在Startup.cs文件中配置Swagger中间件，最终通过Swagger-UI进行API测试。

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

项目类型：asp.net core webapi

1.NuGet安装：Swashbuckle.AspNetCore

2.Startup.cs下的：
ConfigureServices()加入:
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new Info
{
Version = "v1",
Title = "Swagger测试接口文档",
Description = "this is just a test"

});

var basePath = PlatformServices.Default.Application.ApplicationBasePath;
var xmlPath = Path.Combine(basePath, "SwaggerTest.xml");
c.IncludeXmlComments(xmlPath);

// c.OperationFilter<HttpHeaderOperation>(); // 添加httpHeader参数

});

Configure()加入:
app.UseSwagger();
// Enable middleware to serve swagger-ui (HTML, JS, CSS etc.), specifying the Swagger JSON endpoint.
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "其实，我是一个演员。");
c.ShowRequestHeaders();

});