首页 > 编程语言 >搭建Swagger框架时,浏览不到Swashbuckle.AspNetCore包的简单解决办法

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

时间:2022-10-08 14:11:29浏览次数:83  
标签:app 文档 Swashbuckle using Swagger AspNetCore

什么是Swagger?

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

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

 

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;  //设置根节点访问
   });
   
}

 

 

 

 

标签:app,文档,Swashbuckle,using,Swagger,AspNetCore
From: https://www.cnblogs.com/Kendy/p/16768772.html

相关文章

  • camunda_14_swagger
    预编译软件包支持Swagger命令行启动官方预编译,缺省情况下就已经启动了swaggerui.PSC:\my_program\camunda-bpm-run-7.17.0>.\start.batSettingJAVA......
  • Springboot2.6整合Swagger3时报错this.condition is null的解决方案
    错误Springboot2.6整合Swagger3时报错:this.conditionisnull:解决方案这个问题主要出现在SpringBoot2.6及以后,只要是SpringBoot2.6引入的新PathPatternParser导致的......
  • SpringBoot整合Swagger
    什么是Swagger?Swagger是目前最常用的接口生成文档工具之一。Swagger通过注解接口生成网页的在线文档,文档包括接口名、请求方法、参数、返回信息等。更多信息参考:Whatis......
  • 【Java】【组件使用】【Swagger2的基本使用】
    【Java】【组件使用】【Swagger2的基本使用】以下使用皆基于springboot项目。一、Jar包的引入的两种方式1.1、使用swagger官方提供的jar包1.1.1、第一步在pom文件里引......
  • .Net Swagger的相关配置
    //1、接口传出接口序列化#region--JsonSerializerSettings配置--builder.Services.AddControllers().AddNewtonsoftJson(opt=>{//忽略循环引用opt.Seriali......
  • swagger 和 knife4j
    1.导入依赖io.springfoxspringfox-swagger2io.springfoxspringfox-swagger-ui2.添加配置类(注意:如果配置类不在一个模块下,那么要进行包扫描@Comp......
  • swagger2 报404
    @ConfigurationpublicclassCommonConfigextendsWebMvcConfigurationSupport{@OverridepublicvoidaddResourceHandlers(ResourceHandlerRegistryregistr......
  • NET5+JWT+VUE+Swagger登录权限验证2——跨域Cors
    在ConfigureServices添加如下代码://注册cros--->跨域services.AddCors(option=>{option.AddPolicy("any",build=>......
  • NET5+JWT+VUE+Swagger登录权限验证3——JWT权限认证1
    注册://配置认证服务services.AddAuthentication(x=>{x.DefaultAuthenticateScheme=JwtBearerDefaults.AuthenticationScheme......
  • NET5+JWT+VUE+Swagger登录权限验证1——Swagger增加JWT验证
    项目添加Swagger后,此时浏览器可直接校验;当添加JWT后,浏览器无输入token位置,若想在浏览器界面增加token校验,需在ConfigureServices增加如下信息:services.AddSwaggerGen(c=>......