搭建Swagger框架时,浏览不到Swashbuckle.AspNetCore包的简单解决办法

本文介绍Swagger——一款用于RESTful接口文档自动生成及功能测试的工具。详细讲述了如何通过NuGet安装并配置Swagger到.NET Core Web API项目中,包括添加必要的命名空间、配置Swagger生成器和服务等步骤。

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

什么是Swagger?

Swagger是一款RESTFUL接口的文档在线自动生成+功能测试的软件。

Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化RESTFUL风格的Web服务。

详情请访问相关播客:Swagger简介

 

1、首先找到项目中的“依赖项”--->"管理NuGet程序包"

2、然后点开包源管理里面的设置

3、复制如下链接,操作步骤如下:

https://api.nuget.org/v3/index.json

4、然后选择这个包源,再进行搜索就有了:

5、安装完成之后,编辑Startup.cs文件。

//首先引入三个命名空间
using System.IO;
using System.Reflection;
using Swashbuckle.AspNetCore.Swagger;


//配置Swagger
//注册Swagger生成器,定义一个Swagger 文档
public void ConfigureServices(IServiceCollection services)
{
    .....

    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo
        {
             Version = "v1",
             Title = "接口文档",
             Description = "RESTful API"
        });

        // 为 Swagger 设置xml文档注释路径
        var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
        var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
        c.IncludeXmlComments(xmlPath);
    });

}


public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
   ....

   //启用中间件服务生成Swagger
   app.UseSwagger();
   //启用中间件服务生成Swagger,指定Swagger JSON根节点
   app.UseSwaggerUI(c =>
   {
      c.SwaggerEndpoint("/swagger/v1/swagger.json", "Web App V1");
      c.RoutePrefix = string.Empty;  //设置根节点访问
   });
   
}

详细步骤请移步相关播客:.Net Core WebApi(一) 简单创建及使用

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值