.net core使用swagger配置api接口文档

最新推荐文章于 2024-08-08 11:47:18 发布

宝宝不浪

最新推荐文章于 2024-08-08 11:47:18 发布

阅读量423

点赞数

分类专栏： .net core 文章标签： c#

本文链接：https://blog.csdn.net/qq_15787371/article/details/105490093

版权

.net core 专栏收录该内容

3 篇文章 0 订阅

订阅专栏

.net core使用swagger配置api接口文档

第一步
第二部
第三步
第四步方便展示配置
大功告成

第一步

使用NuGet程序包管理添加Swashbuckle.AspNetCore的引用

第二部

Startup.cs类的ConfigureServices方法中添加如下代码

//配置API接口说明文档
 services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new OpenApiInfo { Title = "Hello", Version = "v1" }); 
                var xmlPath = Path.Combine(AppContext.BaseDirectory, "WebApiSwaggerCore.xml"); 
                c.IncludeXmlComments(xmlPath);
            });

以上代码中的OpenApiInfo类在低版本的Swashbuckle.AspNetCore包中改为Info类
Startup.cs类的Configure方法中添加如下代码

//配置API接口说明文档
 app.UseSwagger();
            app.UseSwaggerUI(c =>
            { 
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "test V1");
                c.RoutePrefix = string.Empty;//如果不设置这个，浏览器的链接为https://localhost:44334/swagger/index.html，设置了就是https://localhost:44334/index.html
            });