Asp.NetCoreWebAPI使用Swagger时API隐藏和分组详解_.netcoreswagger分组

181 浏览量更新于2023-03-16 评论收藏 64KB PDF 举报

身份认证购VIP最低享 7 折!

领优惠券(最高得80元）

资源详情

资源评论

资源推荐

Asp.Net Core WebAPI使用使用Swagger时时API隐藏和分组详解隐藏和分组详解

主要给大家介绍了关于Asp.Net Core WebAPI使用Swagger时API隐藏和分组的相关资料，文中通过示例代码介

绍的非常详细，对大家学习或者使用Asp.Net Core具有一定的参考学习价值，需要的朋友们下面来一起学习学

习吧

1、前言、前言

为什么我们要隐藏部分接口？

因为我们在用swagger代替接口的时候，难免有些接口会直观的暴露出来，比如我们结合Consul一起使用的时候，会将健康检

查接口以及报警通知接口暴露出来，这些接口有时候会出于方便考虑，没有进行加密，这个时候我们就需要把接口隐藏起来，

只有内部的开发者知道。

为什么要分组？为什么要分组？

通常当我们写前后端分离的项目的时候，难免会遇到编写很多接口供前端页面进行调用，当接口达到几百个的时候就需要区分

哪些是框架接口，哪些是业务接口，这时候给swaggerUI的接口分组是个不错的选择。

swagger的基本使用这里将不再赘述，可以阅读微软官方文档，即可基本使用

2、、swaggerUI中加入授权请求中加入授权请求

新建HttpHeaderOperationFilter操作过滤器，继承Swashbuckle.AspNetCore.SwaggerGen.IOperationFilter接口，实现Apply方法

/// <summary>

/// swagger请求头

/// </summary>

public class HttpHeaderOperationFilter : IOperationFilter

{

public void Apply(Operation operation, OperationFilterContext context)

{

#region 新方法

if (operation.Parameters == null)

{

operation.Parameters = new List<IParameter>();

}

if (context.ApiDescription.TryGetMethodInfo(out MethodInfo methodInfo))

{

if (!methodInfo.CustomAttributes.Any(t => t.AttributeType == typeof(AllowAnonymousAttribute))

&&!(methodInfo.ReflectedType.CustomAttributes.Any(t => t.AttributeType == typeof(AuthorizeAttribute))))

{

operation.Parameters.Add(new NonBodyParameter

{

Name = "Authorization",

In = "header",

Type = "string",

Required = true,

Description = "请输入Token，格式为bearer XXX"

});

}

#endregion

#region 已过时

//if (operation.Parameters == null)

//{

// operation.Parameters = new List<IParameter>();

//}

//var actionAttrs = context.ApiDescription.ActionAttributes().ToList();

//var isAuthorized = actionAttrs.Any(a => a.GetType() == typeof(AuthorizeAttribute));

//if (isAuthorized == false)

//{

// var controllerAttrs = context.ApiDescription.ControllerAttributes();

// isAuthorized = controllerAttrs.Any(a => a.GetType() == typeof(AuthorizeAttribute));

//}

//var isAllowAnonymous = actionAttrs.Any(a => a.GetType() == typeof(AllowAnonymousAttribute));

//if (isAuthorized && isAllowAnonymous == false)

//{

// operation.Parameters.Add(new NonBodyParameter

// {

// Name = "Authorization",

// In = "header",

// Type = "string",

本内容试读结束，登录后可阅读更多

下载后可阅读完整内容，剩余3页未读，立即下载

weixin_38629206

粉丝: 4
资源: 959

会员权益专享

Asp.Net Core WebAPI使用Swagger时API隐藏和分组详解

评论0

会员权益专享

最新资源

Asp.Net Core WebAPI使用Swagger时API隐藏和分组详解

评论0

asp.net core 3.0中使用swagger的方法与问题

asp.net webapi集成swagger自动生成接口文档(亲测可用)

SwaggerGroup.zip

asp.net core web api

在iis上部署你的asp.net core web api项目及swagger

.net core web api

.net core webapi增删改查

.net core webapi网上书店

.netcore web api

.net core3.1 webapi 项目框架

.NET WEBAPI 的 UseSwaggerUI

.net6框架下使用swagger3，修改根目录

为什么.net6 core打包成exe运行后浏览器可以访问localhost5000，但是.net6 core webapi打包后无法运行http://localhost:5000/swagger/index.html

asp.net webapi如何自动生成接口文档

webapi项目视频推荐

.net core 使用swagger导出离线文档

ASP.net webapicore发布成exe运行后为啥无法访问swagger？

.net6 core webapi打包后无法运行http://localhost:5000/swagger/index.html

webapi webservice接口开发案例入门 .net接口开发

building restful web services with .net core

会员权益专享

最新资源