Swagger-ui 设置接口文档页面默认展开/关闭的方法

最新推荐文章于 2024-04-18 20:42:23 发布
最新推荐文章于 2024-04-18 20:42:23 发布
阅读量2.8k 收藏
点赞数 1
分类专栏： Java开发 文章标签： swagger2
原文链接：https://blog.csdn.net/nginxlee/article/details/102512467
版权

关键配置参数：docExpansion， 可选值有 none / list / full 分别表示关闭、展开列表、展开列表及详情
配置方法：

第一种: 在文档浏览的时候，浏览器路径中增加参数 docExpansion=none即可关闭默认展开

第二种：vendor/swagger-api/swagger-ui/dist/swagger-ui-bundle.js 中找到 docExpansion:"list"

把list改成none即可全局默认不展开接口列表。

此方法对Laravel的L5-swagger插件同样有用！
千万别熬夜啊
关注
  • 1
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
swagger-bootstrap-ui：Swagger-bootstrap-ui是Swagger的前端UI实现，目的是替换Swagger的默认UI实现Swagger-UI，使文档更加友好...
02-25
Swagger-bootstrap-UI是springfox-swagger的增强型UI实现，它使Java开发人员在使用Swagger时可以获得简单而强大的界面文档体验 2.0： ： 在线效果： : 项目演示： ： 文件： ： QQ通讯群：621154782 核 UI...
【swagger2】更改swagger2的默认UI界面
qgnczmnmn的博客
11-08 5979
参考博客：https://blog.csdn.net/X_Xian_/article/details/82969105
Spring Boot 集成 Swagger2 使用默认UI和替换默认UI
weixin_33874713的博客
01-03 638
2019独角兽企业重金招聘Python工程师标准>>> ...
Swagger接口文档 —— 手把手教学，全方位超详细小白能看懂，百分百能用Java版
最新发布
dream_ready的博客
04-18 1637
使用Swagger你只需要按照它的规范去定义接口及接口相关的信息，就可以做到生成接口文档，以及在线接口调试页面。官网：https://swagger.io/是为Java MVC框架集成Swagger生成Api文档的增强解决方案。
如何使用vue去美化Swagger 默认UI（doing）FM UI
黄大胆的博客
08-18 872
使用vue 美化swagger 默认 ui ，注意：此UI猛男适用。
Swagger_tornado设置默认不展开标签docExpansion
wangscaler的博客
09-15 821
Swagger_tornado设置默认关闭标签 一、通过在地址栏，添加?docExpansion=none 成功关闭标签。 二、通过修改配置文件修改。 此安装包使用pip3安装，所以找到python3的虚拟环境此包的位置。 如果是默认的python3环境，在包在 /usr/local/python3/lib/python3.7/site-packages/tornado_swagger/swagger_ui 将ui.html进行修改 vim ui.htm 添加字段 docExpansion=none
如何关闭swagger-ui.html
weixin_35748962的博客
12-19 3320
要关闭 Swagger UI，您需要停止运行您的应用程序。这将使 Swagger UI 不再可用。 如果您使用的是本地开发服务器，可以使用“CTRL + C”快捷键来停止运行服务器。如果您使用的是远程服务器，则需要使用服务器控制面板或命令行工具来停止服务器。 此外，还可以通过在 Swagger UI 的 URL 中添加“?url=”参数来关闭 Swagger UI。例如，如果您的 Swagger ...
Springboot线上环境彻底关闭Swagger-UI
l_mmf的博客
06-01 6281
2.创建一个控制类使用@Profile仅线上环境生效,使访问swagger-ui.html返回404。通过这种方式可以彻底关闭线上环境访问swagger-ui.html直接返回404。1.SwaggerConfig使用@Profile排除线上环境其他环境生效。Springboot线上环境彻底关闭Swagger-UI。
swagger2默认不展开/展开
fsdf8sad7的博客
04-23 4554
当接口太多的时候,接口全部展开的时候访问会非常卡,点击一个接口也要卡很久。 后来在地址栏上加一个参数就不会展开了。 http://XXXXX/swagger2/index.html?docExpansion 或者在swagger2的index.html资源文件配置一下docExpansion,就可以了。 const ui = SwaggerUIBundle({ url: window.lo...
在生产环境关闭swagger
凌晨港口
05-10 6263
在服务中引入了swagger文档，但在生产环境需要屏蔽；否定请求可以看到所有api；
angular-swagger-ui：Swagger UI的angularJS实现
01-30
角度摇摆UI angular-swagger-ui是OpenAPI UI的angularJS实现 （又名 ）可帮助您记录RESTful API。 OpenAPI UI通过为在线文档提供集成的API资源管理器来帮助开发人员发现您的RESTful API。警告默认情况下，仅支持...
swagger-ui-layer
05-14
ui,让生成的文档更加友好和美观swagger-ui-layer 要依赖swagger的注解功能，因为swagger-ui-layer 仅仅只是一个前端UI界面的实现，解析的数据来源于 /v2/api-docs更新接口展示增加排序，默认使用升序，按字典排序...
swagger，基于swagger的前端UI实现
05-05
现在市面上的swagger UI不足之处 1、原生UI显示的有些不够...本页面替换了默认的swagger-ui,让生成的文档更加友好和美观。 要依赖swagger的注解功能，仅仅只是一个前端UI界面的实现，解析的数据来源于json/swagger.json
LemonsJ:LemonsJ（柠檬精）- API接口文档工具，支持Postman、Swagger上传
05-24
LemonsJ（柠檬J）- API接口文档工具，支持Postman、Swagger上传 环境依赖 laravel 7.0 php 7.2.10 安装 参照 Laravel框架 安装 根目录 lemonsj.sql 功能介绍 可编辑文档类型：表格文档、markdown文档、富文本（html...
微服务架构系列主题：生产环境关闭swagger方法
Larry的博客
05-18 4323
目录 swagger3 关闭配置（快捷方式） 配置原理 swagger2 关闭配置 方法一：@ConditionalOnProperty 方法二 @Profile 方法三 @Value 配置Docket 失效办法 swagger3 关闭配置（快捷方式） springfox: documentation: # 总开关（同时设置auto-startup=false，否则/v3/api-docs等接口仍能继续访问） enabled: false auto-startu
Swagger3.0+springboot 默认开启
qaq1314520的博客
11-10 403
1.新建springboot项目（略过） 2.添加swagger3.0依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </depend
【swagger关闭】生产环境关闭swagger方法
热门推荐
m0_67391401的博客
07-31 2万+
先自我介绍一下，小编13年上师交大毕业，曾经在小公司待过，去过华为OPPO等大厂，18年进入阿里，直到现在。深知大多数初中级java工程师，想要升技能，往往是需要自己摸索成长或是报班学习，但对于培训机构动则近万元的学费，着实压力不小。因此我收集了一份《java开发全套学习资料》送给大家，初衷也很简单，就是希望帮助到想自学又不知道该从何学起的朋友，同时减轻大家的负担。添加下方名片，即可获取全套学习资料哦。原理跟第一个差不多，只是判断条件不同（profile判断配置文件，也即的参数）...
SpringBoot 集成 Swagger UI 及 开关
LZHH_2008的博客
10-30 569
1. 添加 POM配置 <!-- swagger UI 的依赖 开始 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>
用swagger-maven-plugin生成接口文档swagger.json或者swagger.yaml
03-20
Swagger Maven Plugin是一个用于生成Swagger接口文档的Maven插件。它可以帮助开发人员在构建项目时自动生成Swagger规范的JSON或YAML文件，以便于API文档的管理和使用。 使用Swagger Maven Plugin生成接口文档swagger.json或swagger.yaml的步骤如下： 1. 在项目的pom.xml文件中添加Swagger Maven Plugin的依赖配置： ```xml <build> <plugins> <plugin> <groupId>com.github.kongchen</groupId> <artifactId>swagger-maven-plugin</artifactId> <version>3.1.8</version> <configuration> <!-- 配置Swagger文档的基本信息 --> <apiSources> <apiSource> <springmvc>true</springmvc> <locations>com.example.controller</locations> <basePath>/api</basePath> <info> <title>API文档</title> <version>1.0.0</version> <description>API接口文档</description> <termsOfServiceUrl>http://example.com/terms-of-service</termsOfServiceUrl> <contact> <email>contact@example.com</email> </contact> <license> <name>Apache 2.0</name> <url>http://www.apache.org/licenses/LICENSE-2.0.html</url> </license> </info> </apiSource> </apiSources> </configuration> <executions> <execution> <phase>compile</phase> <goals> <goal>generate</goal> </goals> </execution> </executions> </plugin> </plugins> </build> ``` 2. 在项目根目录下执行以下命令生成Swagger接口文档： ``` mvn compile swagger:generate ``` 3. 执行完上述命令后，Swagger Maven Plugin会根据配置的信息扫描项目中的接口，并生成Swagger规范的JSON或YAML文件。生成的文件默认保存在项目的target目录下的swagger目录中。 生成的Swagger接口文档可以通过访问http://localhost:8080/api/swagger-ui.html（假设项目部署在本地的8080端口）来查看和测试API接口。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值