Net5中使用Swagger


1. 新建netcore项目

2. 使用nuget包安装 Swashbuckle.AspNetCore

使用RestorePackagesPath属性配置nuget包的路径(可选)

  <PropertyGroup>
    <TargetFramework>net5.0</TargetFramework>
      <RestorePackagesPath>..\packages</RestorePackagesPath>
  </PropertyGroup>

3. 勾选生成项目xml文件

 

 

 4.在Startup中添加代码

在ConfigureServices 中添加配置。

services.AddSwaggerGen(c =>
 {
    c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
   
   var basePath = HostEnvironment.ContentRootPath;
   var xmlPath = Path.Combine(basePath, $"{typeof(Startup).Namespace}.xml");
   c.IncludeXmlComments(xmlPath, true);
});

在Configure中添加代码

 app.UseSwagger(); 
app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1"); });

 

5.访问

/swagger (访问swagger页面。)

/swagger/v1/swagger.json  (查看异常页)

 


免责声明!

本站转载的文章为个人学习借鉴使用,本站对版权不负任何法律责任。如果侵犯了您的隐私权益,请联系本站邮箱yoyou2525@163.com删除。



 
粤ICP备18138465号  © 2018-2025 CODEPRJ.COM