ASP .NET Core 如何配置Swagger API接口文档

认识Swagger

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。
作用:

1 接口的文档在线自动生成。
2 功能测试。

为什么使用Swagger作为REST APIs文档生成工具

1 Swagger 可以生成一个具有互动性的API控制台,开发者可以用来快速学习和尝试API。
2 Swagger 可以生成客户端SDK代码用于各种不同的平台上的实现。
3 Swagger 文件可以在许多不同的平台上从代码注释中自动生成。
4 Swagger 有一个强大的社区,里面有许多强悍的贡献者。

安装Nuget包搜索Swashbuckle.AspNetCore

1.创建一个Asp.NetCoreWebApi项目;
2.使用Nuget安装Swagger:
3 项目右键–》管理nuget程序包;
4 搜索Swashbuckle.AspNetCore并安装。
在这里插入图片描述

怎么在 startup注册,引用 Swagger

注册Swagger

 //注册swaggert
            services.AddSwaggerGen(m =>
            {
                //v1自己定义  Title项目名  Version版本 值自己定义
                m.SwaggerDoc("v1", new OpenApiInfo { Title = "BBSWebServer", Version = "v1" });
            });

添加Swagger 引用

 //中间件引用swaggert服务
            app.UseSwagger();
            //v1一定要个前面注册的那个一致
            app.UseSwaggerUI(M=> {
                M.SwaggerEndpoint("/swagger/v1/swagger.json", "swaggerTest");
            });
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值