文章/答案/技术大牛

发布

社区首页 >问答首页 >关于openAPI，有没有什么集中的方法来限制api对swagger ui的暴露？

问关于openAPI，有没有什么集中的方法来限制api对swagger ui的暴露？
EN

Stack Overflow用户

提问于 2020-06-25 09:36:37

回答 1查看 223关注 0票数 1

我刚刚从springfox迁移到spring-doc，现在它公开了我的spring-boot项目中的所有openAPI文档。有没有任何集中的方式来管理它，因为在我们的例子中，使用@Hidden注解是不可行的，因为我们必须修改我们的所有控制器。

任何建议都将不胜感激。

openapi

springdoc-openapi-ui

api

swagger

回答 1

Stack Overflow用户

发布于 2020-08-13 17:41:44

您可以使用：

包含要排除的路径的Strings.The列表的springdoc.paths-to-exclude属性(逗号分隔)

或包含要排除的包的Strings.The列表的springdoc.packages-to-exclude属性(逗号分隔)。

或者，您可以使用spring-boot配置文件动态加载组。请注意，对于这种用法，您不必声明GroupedOpenApi Bean。您需要在前缀springdoc.group-configs下声明以下属性。

springdoc.group-configs[0].group=users
springdoc.group-configs[0].paths-to-match=/user/**
springdoc.group-configs[0].packages-to-scan=test.org.springdoc.api

票数 1

页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持

原文链接：

https://stackoverflow.com/questions/62572298

复制

如何更好管理 Api 接口（续）

api java openapi 编程算法 typescript

那有什么办法可以解决上述的问题？方法是有的，本质上通过程序自动化去生成各种service文件，解放双手。那具体怎么做呢？我们可以通过解析swagger接口文档的结构

树酱

2022/03/09

1.9K0

Swagger UI教程 API 文档神器

api

在一些接口项目中，API的使用很频繁，所以一款API在线文档生成和测试工具非常有必要。而Swagger UI就是这么一款很实用的在线工具本博客介绍如何在公司或者自己的电脑上按照Swagger UI，注意因为公司的测试服务器是Linux系统的，所以本博客也只介绍基于Linux系统的Swagger环境搭建过程

SmileNicky

2019/01/17

4.9K0

6款国内外好用的API文档工具介绍

java python html api

从零编写API文档既耗时又复杂，因此大多数企业都依赖API文档工具来简化这些工作。 API文档工具有助于自动化创建和管理文档，并以易于阅读和理解的方式帮助用户去格式化和显示信息，即使对于没有技术背景的用户也能轻松使用。

快递100API

2021/05/17

5.9K1

OpenAPI规范3-Swagger2 的美化使用

java api openapi bootstrap http

本人自己使用的swagger2.0，鉴于颜值和OpenAPI规范，就想体验下，后续再补充各种情况的demo。

软件测试君

2022/01/24

6.6K0

API管理-舍弃springfox-swagger-ui，采用功能更加丰富的swagger-bootstrap-ui

java bootstrap markdown https 网络安全

上一篇博客（API管理-基于SpringBoot项目集成swagger实现接口文档自动生成）中我已经提到过使用springfox-swagger-ui的部分问题，上下结构的接口层次不利于接口的查看、无法支持离线下载成pdf或word或html等，而swagger-bootstrap-ui的出现把这些问题都解决了并且还扩展了部分实用新功能，比如：新增接口页面权限功能..

秋日芒草

2019/06/24

2K0

API管理-舍弃springfox-swagger-ui，采用功能更加丰富的swagger-bootstrap-ui

关于Memcached对key和value的限制

memcached

Memcached中对于键（key）的限制为最大不超过250个字符。同时，对于存储的value最大可以接受的数据不能超过1MB。

魏杰

2022/12/23

4670

Swagger2使用教程

测试教程接口配置注解

Swagger 是一套基于 OpenAPI 规范（OpenAPI Specification，OAS）构建的开源工具，后来成为了 Open API 标准的主要定义者。对于 Rest API 来说很重要的一部分内容就是文档，Swagger 为我们提供了一套通过代码和注解自动生成文档的方法。

魚迹

2023/05/06

1.4K0

restful Api 风格契约设计器：Swagger-editor和swagger-ui的应用

数据结构

swagger-editor的安装 swagger-editor应用的yaml语法，有定义变量和数据结构，不明白可以参考其示例安装步骤：下载swagger-editor git地址运行npm run build生成可运行的包 window注意事项：去掉package.json文件中scripts节点的prebuild功能，不然会提示 rm -rf dist/** 无效，看出这是删除生成包的文件，可以手动删除或者自己改下命令。更改.eslintrc.js文件，主要是修正linebreak-

sam dragon

2018/01/17

1.7K0

restful Api 风格契约设计器：Swagger-editor和swagger-ui的应用

API First 再先一步，OpenAPI 定义被 openAI 定为 ChatGPT 插件标准

chatgpt openapi openai 程序员前端

最近，OpenAI 宣布了一个重大的更新： ChatGPT 支持 Plugin 能力。用户在与 ChatGPT 自然语言交互时，可以选择使用插件。通过插件扩展，可以实现让 ChatGPT 实现以下能力：

物立

2023/04/07

9320

SpringBoot中使用Swagger详解

api openapi 腾讯云测试服务网站 spring boot

Swagger是一套基于OpenAPI规范构建的开源工具，可以帮助我们设计、构建、记录以及使用Rest API。Swagger主要包括了一下三个部分：

秋名山码神

2023/01/10

1K0

SpringBoot中使用Swagger详解

api openapi 腾讯云测试服务 java 网站

Swagger是一套基于OpenAPI规范构建的开源工具，可以帮助我们设计、构建、记录以及使用Rest API。Swagger主要包括了一下三个部分：

秋名山码神

2023/01/13

6770

SpringBoot3集成Swagger

swagger ui 模型排序配置

springfox 已经停止更新很久了，SpringBoot新版本都不支持。为了能够继续使用Swagger，只能调整继承库。

郭顺发

2023/07/17

2.2K0

Swagger笔记—Swagger3详细配置

api openapi java

Swagger是一组围绕 OpenAPI 规范构建的开源工具，可帮助您设计、构建、记录和使用 REST API。主要的 Swagger 工具包括：Swagger Editor – 基于浏览器的编辑器，您可以在其中编写 OpenAPI 规范。Swagger UI – 将 OpenAPI 规范呈现为交互式 API 文档。Swagger2于17年停止维护，现在最新的版本为 Swagger3（Open Api3）。

软件测试君

2022/01/24

6.1K0

Swagger UI

java spring api http https

在前后端分离并行开发时，当定完需求文档，需要根据接口文档进行接口对接，如果接口文档后置进行，对完成的接口进行参数输出输出也能棘手，毕竟可以进行测试，打印参数，几遍是这样，使用Yapi的时候也需要手动或导入Json的形式书写，如果接口发生变动，还需要随之改变接口文档，学习下swagger API生成文档。

疯狂的KK

2020/07/07

1.3K0

Spring Boot中使用Swagger CodeGen生成REST client

java api spring openapi spring boot

Spring Boot中使用Swagger CodeGen生成REST client

程序那些事

2020/07/07

3K0

Swagger3.0官方starter诞生，可以扔掉那些野生starter了

java json spring api openapi

对于 Rest API 来说很重要的一部分内容就是文档，Swagger 为我们提供了一套通过代码和注解自动生成文档的方法，这一点对于保证 API 文档的及时性将有很大的帮助。

业余草

2020/10/26

2.3K0

Swagger详细了解一下（长文谨慎阅读）

java api openapi json

Swagger 是最流行的 API 开发工具，它遵循 OpenAPI Specification（OpenAPI 规范，也简称 OAS）。 Swagger 可以贯穿于整个 API 生态，如 API 的设计、编写 API 文档、测试和部署。 Swagger 是一种通用的，和编程语言无关的 API 描述规范。

IT苦逼一枚

2020/04/27

32.7K0

Swagger

java json 渲染 api openapi

扬起

2022/12/06

1.7K0

Docker API暴露下的危机

容器镜像服务 api 容器 shell

Docker 是一个开源的应用容器引擎，让开发者可以打包他们的应用以及依赖包到一个可移植的镜像中，然后发布到任何流行的 Linux或Windows 机器上，也可以实现虚拟化。容器是完全使用沙箱机制，相互之间不会有任何接口。

洛米唯熊

2019/10/09

6690

swagger-ui教程-构建api接口文档工具

其他

之前写过关于app后端开发的一系列文章，那是我第一次做app后端开发，存在很多不足，本想好好修改一下，想想还是重新写吧，这样子也能让我博客文章看起来多一点嘛，万一以后找工作，别人一看我博客这么多内容，是不是很屌？这次文章先从构建resetful风格的api文档工具开始。没有一个好的文档工具，在app前端人员开发过程中会导致开发效率极低，而且时不时的，他们就来找你跟他们断点一下。

wuweixiang

2018/08/14

1K0

相似问题

限制对Swagger UI的访问

Swagger openapi: openapi.yaml/ swagger-ui中的过滤方法

125

API请求对Swagger模式的验证(openapi 3.0.2)

111

使用swagger ui从OpenAPI规范导出API路径列表

143

OpenAPI/Swagger-UI注释& @BeanParam

1111

添加站长进交流群

领取专属 10元无门槛券

AI混元助手 在线答疑

关注 腾讯云开发者公众号

洞察 腾讯核心技术

剖析业界实践案例

问关于openAPI，有没有什么集中的方法来限制api对swagger ui的暴露？
EN