当前位置: 首页 > 知识库问答 >
问题:

SpringDoc中的隐藏参数-OpenAPI不起作用

谢奕
2023-03-14
parameters = {
@Parameter(
    hidden = true, schema = @Schema(implementation = Boolean.class),
    in = ParameterIn.QUERY, name = DO_NOT_FORWARD
)

对于hidden=true,我希望这个参数在swagger-UI中不可见。但确实是。是我误解了这个参数,还是它没有做它应该做的事情?

我希望这个参数在api-docs中,生成能够使用这个参数的客户机,但我希望它在swagger-ui中是不可见的

共有1个答案

吴丁雷
2023-03-14

只需确保@parameter注释中的名称是要隐藏的操作参数的确切名称。

您也可以查看文档:

  • https://springdoc.org/faq.html#how-can-i-hide-a-parameter-from-the-documentation-
 类似资料:
  • springdoc-openapi库自动标记生成的OpenAPI文档中所需的某些属性。例如,注释为的属性将包括在生成的YAML文件中所需的属性列表中。 库不做的一件事是将可选属性标记为。但是,默认情况下,Spring Boot应用程序将在请求中接受,并在可选属性的响应中返回。这意味着OpenAPI文档和endpoint行为之间存在差异。 在SpringDoc-OpenAPI生成的OpenAPI文档

  • 我的应用程序是spingmvc而不是boot。 我正在使用springdoc openapi ui 1.4.4 另外,我在@configuration类中添加了以下导入:; 并实现如下所示的bean 但是当我尝试 给我404。 但是我得到了 它也进来 也没有定义下拉列表。 如果我加上 申请。然后我得到 我做错了什么? 我需要导入任何其他类来获得组功能工作吗? 谢啦

  • 我使用springdoc-openapi来记录我的REST API。错误由错误对象返回,该对象具有和。我使用注释来记录一个示例。然而,我需要每个不同的错误不同的例子。有没有办法,怎么做? 我的代码示例:

  • 昨天我检查了一个突出的产品幻灯片,我在一个网页的首页是不是属性垂直对齐只在火狐,它在IE和Chrome工作正常。 我在搜索信息,很多年前我在FF上发现了很多bug。我尝试了一些我找到的解决方案,但没有一个有效。 在chrome和IE上,div位于窗口的中心,而在firefox中,该功能会向右对齐,使窗口大于100%。 幻灯片基于:http://wordpress.org/extend/plugin

  • 我正在为我的应用程序使用2(左和右)NavigationView,只想在某些条件下显示右NavigationView。因此,在布局文件中设置其可见性为“Gone”,并在需要时使其可见。然而,即使在使其“消失”后,正确的导航视图仍然显示出来。 有什么想法怎么隐藏它吗?

  • 问题内容: 我有一个表格单元格,我一直希望成为一个特定的宽度。但是,它不适用于较大的无间距文本字符串。这是一个测试用例: 如何使文本在框的边缘处被切除,而不是使框展开? 问题答案: 需要设置 和 表元件上的合适的宽度,以及和在桌子上的细胞。 例子 定宽列 表格的宽度必须与固定宽度的单元格相同(或更小)。 使用一个固定宽度的列: 使用多个固定宽度的列: 固定和流体宽度色谱柱 必须设置 表格的宽度,但