.net core 3.1 swagger文档

本文档详细介绍了如何在.NET Core 3.1项目中配置和使用Swagger,包括安装必要的包,设置Startup.cs文件,开启XML文档生成以避免警告,以及如何访问Swagger UI。此外,还提到了启用JWT验证并添加请求头的操作。

.net core 3.1 swagger文档

1.安装包

Swashbuckle.AspNetCore

2.在Startup.cs 配置swagger 在ConfigureServices中添加代码

services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
                var basePath = PlatformServices.Default.Application.ApplicationBasePath;
                //Core.Admin.webapi.xml是我的项目生成XML文档的后缀名,具体的以你项目为主
                var xmlPath = Path.Combine(basePath, "test.API.xml");
                c.IncludeXmlComments(xmlPath);
            });
            
            //分割线
            app.UseSwagger();
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
            });

3.打开主项目属性——》生成 打开xml 并且加上 1591(不加报警告 很烦)

4.访问 swagger/index.html

5.启用jwt验证 添加heads 请求头

//接口文档
            services.AddSwaggerGen(s =>
            {
      
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值