首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

.NET WebAPI 使用 GroupName 对 Controller 分组呈现 Swagger UI

在日常开发 webapi 时,我们往往会集成 swagger doc 进行 api 的文档呈现,当api数量比较多的时候就会导致 swagger ui 上的 api 因为数量太多而显得杂乱,今天教大家如何利用...GroupName 属性来对 api 的 Controller 进行分组,然后利用 swagger ui 上的 Select a definition 切换功能进行多组 Controller 的切换。...#region 启用 Swagger //启用中间件服务生成Swagger作为JSON端点 app.UseSwagger(); //启用中间件服务对swagger-ui,指定Swagger JSON...至此 .NET WebAPI 使用 GroupName 对 Controller 分组呈现 Swagger UI 就讲解完了,有任何不明白的,可以在文章下面评论或者私信我,欢迎大家积极的讨论交流,有兴趣的朋友可以关注我目前在维护的一个....net 基础框架项目,项目地址如下 https://github.com/berkerdong/NetEngine.git https://gitee.com/berkerdong/NetEngine.git

98440
您找到你想要的搜索结果了吗?
是的
没有找到

从壹开始前后端分离【 .NET Core2.2 +Vue2.0 】框架之五 || Swagger的使用 3.3 JWT权限验证

书接上文,在前边的两篇文章中,我们简单提到了接口文档神器Swagger, 《三 || Swagger的使用 3.1》、 《四 || Swagger的使用 3.2》, 两个文章中,也对常见的几个问题做了简单的讨论...一、JWT授权认证流程——自定义中间件 在之前的搭建中,swagger已经基本成型,其实其功能之多,不是我这三篇所能写完的,想要添加权限,先从服务开始 0、Swagger中开启JWT服务 我们要测试 JWT...质询与应答的工作流程如下:服务器端向客户端返回401(Unauthorized,授权)状态码,并在WWW-Authenticate头中添加如何进行验证的信息,其中至少包含有一种质询方式。...标准:在Cookie认证中,用户登录时,返回一个302到登录页面,这在非浏览器情况下很难处理,而Bearer验证则返回的是标准的401 challenge。...Challenge: 授权时调用。

1.9K30

学生教务管理系统开源

1、项目可取之处 毕竟是老张出品,还是有些可取之处的: 后端设计 后端 Student.Achieve.Api 为 Blog.Core 项目的迷你精简版,功能很少: 0、ASP.NET Core...) 1、(展示层 + 仓储 + 接口)的分层设计; 2、使用SqlSugar ORM 并初始化DB数据; 3、Automapper 实现对象映射; 4、CORS 实现跨域(用来支持IIS部署); 5、Swagger...; ※、核心的还是教学教务系统的结构设计: 前端设计 前端 Student.Achieve.UI 为 Blog.Admin 项目的使用版本,有一定的出入: 0、Vue 2 + Ele...UI 1、Router 路由 2、Axios 数据请求; 3、Automapper 实现对象映射; 4、动态路由 + 导航条; 5、提供上传功能; 6、JWT 实现自定义策略授权认证; 7、Autofac...2、有哪些弊端 既然是个人产品,肯定有很多问题,这里简单说一下: 1、框架2.2 目前还是ASP.Net Core2.2版本,功能很少也不够优美,虽然用的内容也不多,不过肯定更新到3.1更好,这个看使用的人数吧

2K10

老开源项目:.NET Core 3.1 + EF Core + LayUI 管理系统

前言 项目名称:学生信息管理系统1.0 后台框架:.Net Core 3.1 + EF Core yrjw.ORM.Chimp 前端框架:ASP.NET Core MVC + LayUI +...框架封装介绍 1、简单三层架构,前后端分离模式,目前采用Layui前端组件的MVC框架,后面可直接替换UI层VUE等前端框架。...6、添加Swagger,添加Jwt身份认证,模型验证结果格式化。 7、封装了Serilog日志组件。 8、封装了MemoryCache缓存。 9、封装了Auth.Jwt身份认证。...MVC版代替UI层进行过度一下,关于微服务这块本人一直在学习过程中,搭建微服务架构还需要一点点时间吧,先来个单应用程序部署,对于小项目来说也是最佳选择不是吗。...先说说本次框架都有哪些改变,由之前的.NET Core2.2直接升级采用最新版.NET Core3.1开发,ORM框架还是采用官方的EF Core(为什么选他就不多纠结了,只为学习目的,后期也可能会换成其他轻量级框架如

29710

【ASP.NET Core 基础知识】--Web API--Swagger文档生成

一、ASP.NET Core Web Api中集成Swagger 在ASP.NET Core Web API中集成Swagger是一种有效的方式,通过Swagger能够自动生成、展示并测试API文档。...以下是一些在ASP.NET Core Web API中自定义Swagger UI外观的常见方式: 引入自定义样式表: 在Swagger UI中,你可以通过引入自定义的CSS样式表来修改外观。...Password",你可以告诉Swagger不要在文档中显示密码属性。 自定义过滤器: 通过实现 Swagger 过滤器接口,你可以编写自定义逻辑,控制哪些信息显示Swagger 文档中。...UI 配置认证按钮: 为了让Swagger UI显示认证按钮,你可以添加一个JavaScript文件,并在Swagger配置中引入该文件。...// ... } 通过这些步骤,Swagger UI显示一个 “Authorize” 按钮,用户可以通过输入 JWT Token 进行身份验证。

10900

MongoDB从入门到实战之.NET Core使用MongoDB开发ToDoList系统(2)-Swagger框架集成

Swagger应用场景 如果你的 RESTful API 接口都开发完成了,你可以用 Swagger-editor 来编写 API 文档( yaml 文件 或 json 文件),然后通过 Swagger-ui...UI 的嵌入式版本,因此我们可使用中间件注册调用将该嵌入式版本托管在 ASP.NET Core 应用中使用。...它通常与 Swagger 终结点中间件结合,以自动公开 Swagger JSON。 Swashbuckle.AspNetCore.SwaggerUI:Swagger UI 工具的嵌入式版本。.../localhost:/) 处提供 Swagger UI,请将 RoutePrefix 属性设置为空字符串!!...UI 显示版本的信息如下所示:  API Swagger添加描述 在 Program.cs 中注入XML相关描述: 注意:将 Swagger 配置为使用按照上述说明生成的 XML 文件。

1.2K20

关于FastAPI文档无法显示的问题

Python调试和部署总会碰到各种各样的问题,Python的版本问题,各种包的版本问题,Python的调试和部署快成了一门玄学,这次遭遇到的是FastAPI文档界面无法显示的问题,中间也测试过几种方案。...FastAPI部署后,各页面均正常响应,除了文档页,经查证是FastAPI接口文档中默认使用的是https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.9.0/swagger-ui.css...和https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.9.0/swagger-ui-bundle.js来渲染页面,而这两个URL是外网的CDN,在国内响应超慢,...( *args, **kwargs, swagger_js_url="https://cdn.staticfile.org/swagger-ui/5.2.0/swagger-ui-bundle.min.js...", swagger_css_url="https://cdn.staticfile.org/swagger-ui/5.2.0/swagger-ui.min.css")

28510

在asp.net core2.1中添加中间件以扩展Swashbuckle.AspNetCore3.0支持简单的文档访问权限控制

Swashbuckle.AspNetCore3.0 介绍 一个使用 ASP.NET Core 构建的 API 的 Swagger 工具。...直接从您的路由,控制器和模型生成漂亮的 API 文档,包括用于探索和测试操作的 UI。...继上篇Swashbuckle.AspNetCore3.0 的二次封装与使用分享了二次封装的代码,本篇将分享如何给文档添加一个登录页,控制文档的访问权限(文末附完整 Demo) 关于生产环境接口文档的显示...我有两种想法 将路由前缀改得超级复杂 添加一个拦截器控制 swagger 文档的访问必须获得授权(登录) 大佬若有更好的想法,还望指点一二 下面我将介绍基于 asp.net core2.1 且使用了 Swashbuckle.AspNetCore3.0...swagger 相关请求,判断是否授权登录 若登录则跳转到授权登录页,登录后即可访问 swagger 的资源 如果项目本身有登录系统,可在自定义中间件中使用项目中的登录, 没有的话,我会分享一个简单的用户密码登录的方案

1.1K10

Swagger技术(接口文档实时动态生成工具)

项目 2 导入Spring-fox 依赖 3.启动类添加注解`@EnableSwagger2` 4.访问UI页面`入http://ip:port/swagger-ui.html` 四、Swagger-UI...Swagger UI: 将Open API 规范呈现为交互式API 文档。用可视化UI 展示描述文件。 Swagger Codegen: 将OpenAPI 规范生成为服务器存根和客户端库。...其中springfox-swagger2 是核心内容的封装。springfox-swagger-ui 是对swagger-ui 的封装。 <!...四、Swagger-UI 使用 访问swagger-ui.html 后可以在页面中看到所有需要生成接口文档的控制器名称。 ? 每个控制器中间包含多所有控制器方法的各种访问方式。...通过使用相关注解, 可以方便我们快捷的对UI 页面的信息进行有解释的有选择的显示 ?

8.7K21

Swagger 3.0快速入门

配置 3.配置Swagger API信息 4.修改默认API文档显示页面 配置Swagger自定义扫描接口 自定义扫描接口 配置是否启动Swagger Swagger只在生产环境下使用 配置API文档分组...2 SpringBoot项目整合swagger2需要用到两个依赖:springfox-swagger2和springfox-swagger-ui,用于自动生成swagger文档。...//localhost:${server.port} ---- 3.配置Swagger API信息 在Swagger提供的ui界面,其中的Swagger信息模块我们可以自定义信息内容 我们只需要在...Swagger配置类SwaggerConfig中实例化Docket类队对象的bean实例,通过配置ApiInfo类的信息然后传入Docket的bean实例即可 ---- 4.修改默认API文档显示页面...,可以通过生产环境设置来完成这一需求 ---- swagger 3.0的swagger页面访问url https://ip:port或域名/设置的请求前缀/swagger-ui/index.html#/

1.2K10

Swagger授权访问漏洞

0x01 漏洞描述 - Swagger授权访问 - Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。...Swagger-UI会根据开发人员在代码中的设置来自动生成API说明文档,若存在相关的配置缺陷,攻击者可以授权翻查Swagger接口文档,得到系统功能API接口的详细参数,再构造参数发包,通过回显获取系统大量的敏感信息...0x02 漏洞等级 威胁级别 高危 中危 低危 0x03 漏洞验证 Swagger 授权访问地址存在以下默认路径: /api /api-docs /api-docs/swagger.json...swagger-ui.html/ /api/swagger-ui.json /api/swagger.json /api/swagger/ /api/swagger/ui /api/swagger/ui.../swagger-ui.html/ /swagger-ui.json /swagger-ui/swagger.json /swagger.json /swagger.yml /swagger/ /swagger

40.1K10

.NET Core实战项目之CMS 第十章 设计篇-系统开发框架设计

可是我这里还是要啰嗦两句给你介绍下: 既然微软已经在前两天将正式版的.NET Core SDK升级到了2.2的版本,那么我们的CMS系统就用.NET Core2.2进行搭建吧!...注意:ASP.NET Core2.2对VisualStudio有一定的要求必须是2017的高版本才能用。其目前的版本是15.8.4 总之尽量不要低于我这个版本,我正准备升级呢!...UI 用户UI层:这个就是我们CMS系统所要呈现的用户界面,而我们得CMS系统又包含后台管理模块以及前台网站模块,因此这个解决方案文件夹下面有两个ASP.NET Core网站项目,留个思考题给你吧,猜猜看哪个项目是后台管理模块...这里有两个项目,相信一路看教程过来的朋友一定还记得我的第二篇文章《.NET Core实战项目之CMS 第二章 入门篇-快速入门ASP.NET Core看这篇就够了 》中用的是ViewModel而不是直接用实体对象了...比方说:我们的有一个订单详细页要同时显示订单的信息,以及订单对应的商品列表,这时候怎么办呢?我们用一个ViewModel包含了订单实体,并且包含了商品的列表就可以更方便的把数据传递到视图里面了!

91620
领券