.NET Core 3.0 webapi集成Swagger 5.0

在项目中引用Swashbuckle.AspNetCore和Swashbuckle.AspNetCore.Filters两个dll，在Startup中的ConfigureServices相关配置代码如下

两个重点：

1、options.DocumentFilter<HiddenApiFilter>();定义那些接口方法被隐藏

2、启用oauth2安全授权访问api接口

                options.OperationFilter<SecurityRequirementsOperationFilter>();                //给api添加token令牌证书                options.AddSecurityDefinition("oauth2", new OpenApiSecurityScheme                {                 Description = "JWT授权(数据将在请求头中进行传输) 直接在下框中输入Bearer {token}（注意两者之间是一个空格）\"",                  Name = "Authorization",//jwt默认的参数名称                  In = ParameterLocation.Header,//jwt默认存放Authorization信息的位置(请求头中)                Type = SecuritySchemeType.ApiKey                });

其中使用SecurityRequirementsOperationFilter需要在控制器头部加[Authorization]或则方法头部加[Authorization]，如下：

 [Authorize] public class TokenController : ControllerBase

或者

[Authorize("Customer")]public PersonResponse GetPerson([FromBody]PersonRequest personRequest)

这样在每个接口才会有小锁出现。

更多介绍请参考https://github.com/domaindrivendev/Swashbuckle.AspNetCore和https://github.com/mattfrear/Swashbuckle.AspNetCore.Filters

原文地址：https://www.cnblogs.com/cqinwn/p/10918206.html

.NET社区新闻，深度好文，欢迎访问公众号文章汇总 http://www.csharpkit.com

.NET Core 3.0 webapi集成Swagger 5.0相关推荐

ASP.NET WebAPI 集成 Swagger 启用 OAuth 2.0 配置问题
在 ASP.NET WebAPI 集成 Swagger 后,由于接口使用了 IdentityServer 做的认证,调试起来很不方便:看了下 Swashbuckle 的文档 ,是支持 OAuth2.0 ...
cdh的集成phoenix安装_环境篇：Kylin3.0.1集成CDH6.2.0
环境篇:Kylin3.0.1集成CDH6.2.0 Kylin是什么? Apache Kylin™是一个开源的.分布式的分析型数据仓库,提供Hadoop/Spark 之上的 SQL 查询接口及多维分析( ...
SpringBoot+Cloud+oauth2.0+JWT集成swagger及swagger-bootstrap-ui详细步骤
SpringBoot+Cloud集成swagger及swagger-bootstrap-ui详细步骤如下: 实现效果图引入Maven依赖 swagger的配置文件属性配置文件所需要的类 oauth ...
.net core 3.1 WebApi项目/Swagger支持二级目录
多个webapi项目需要进行集成部署,并且方便前端不产生跨域访问,那肯定是需要部署nginx进行转发,同一域名的情况下,只好采用二级目录进行区分,如果仅仅是webapi的接口转发,相对简单,配置ngi ...
asp.net core 系列之webapi集成EFCore的简单操作教程
因为官网asp.net core webapi教程部分,给出的是使用内存中的数据即 UseInMemoryDatabase 的方式, 这里记录一下,使用SQL Server数据库的方式即 UseSql ...
ASP.NET Core WebApi使用Swagger生成api说明文档看这篇就够了
引言在使用asp.net core 进行api开发完成后,书写api说明文档对于程序员来说想必是件很痛苦的事情吧,但文档又必须写,而且文档的格式如果没有具体要求的话,最终完成的文档则完全取决于开发者 ...
【转】ASP.NET Core WebApi使用Swagger生成api说明文档看这篇就够了
原文链接:https://www.cnblogs.com/yilezhu/p/9241261.html 引言在使用asp.net core 进行api开发完成后,书写api说明文档对于程序员来说想必 ...
C# ABP WebApi与Swagger UI的集成
C# ABP WebApi与Swagger UI的集成本文是配置WebApi与Swagger UI,可以参照 http://www.cnblogs.com/farb/p/ABPSwaggerUIIn ...
asp.net core 3.0 中使用 swagger
asp.net core 3.0 中使用 swagger Intro 上次更新了 asp.net core 3.0 简单的记录了一下 swagger 的使用,那个项目的 api 比较简单,都是匿名接口 ...

.NET Core 3.0 webapi集成Swagger 5.0

.NET Core 3.0 webapi集成Swagger 5.0相关推荐

最新文章

热门文章