随笔 - 32  文章 - 1 评论 - 1 阅读 - 22579
< 2025年3月 >
23 24 25 26 27 28 1
2 3 4 5 6 7 8
9 10 11 12 13 14 15
16 17 18 19 20 21 22
23 24 25 26 27 28 29
30 31 1 2 3 4 5

什么是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;  //设置根节点访问
   });
   
}
复制代码

 

 

 

 

posted on   asp恒心  阅读(493)  评论(0编辑  收藏  举报
相关博文:
阅读排行:
· 无需6万激活码!GitHub神秘组织3小时极速复刻Manus,手把手教你使用OpenManus搭建本
· C#/.NET/.NET Core优秀项目和框架2025年2月简报
· Manus爆火,是硬核还是营销?
· 终于写完轮子一部分:tcp代理 了,记录一下
· 【杭电多校比赛记录】2025“钉耙编程”中国大学生算法设计春季联赛(1)
点击右上角即可分享
微信分享提示