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

显示 Swagger 验证信息

锺英卫
2023-03-14

Swagger UI 不显示请求参数的验证信息。我想显示参数的最小值,最大值,格式,模式(正则表达式)。有谁知道我在Swagger UI上表达参数验证信息的方式吗?

共有2个答案

闽经纬
2023-03-14

通过使用openapi 3.0.0,我得到了一个UI,其中包含 http://editor.swagger.io/ 中显示的验证信息。从 openapi 2 到 openapi 3 的转换可以在以下 URL 完成。https://mermade.org.uk/openapi-converter

李浩邈
2023-03-14

假设您使用Swagger UI 3.x(最新版本),将< code > showCommonExtensions:true 添加到< code>index.html文件中的Swagger UI初始化代码:

const ui = SwaggerUIBundle({
  "dom_id": "#swagger-ui",
  url: "https://petstore.swagger.io/v2/swagger.json",
  showCommonExtensions: true,    // <-----
  ...

了解有关Swagger UI配置参数的更多信息。

 类似资料:
  • 我的类是用Spring Boot Java写的,我用Swagger 2生成它们的文档。我使用的是spring-fox 2 . 9 . 0版本。 为了在Swagger UI中显示验证约束(@min、@max、@pattern等),我在我的application.java中添加了以下几行,其中showExtensions(true),但这不起作用。Swagger UI中的预期结果 我应该改变什么才能得

  • 我的应用程序中嵌入了swagger ui。当我在本地运行我的节点应用程序时,UI工作得很好。 但是,当我将UI部署到我的“real”服务器时,我会在我的招摇过市UI的右下角看到一个错误图像: 我确信这是我正在做的事情,这会把事情搞砸,但我不知道。当我通过http访问swagger ui时,它也可以在本地工作。 然而,当我部署时,我通过apache运行并通过https提供服务,我看到一个错误。更糟糕

  • 我已经成功地将swagger集成到我的项目中 现在,我可以点击URLhttp://localhost:8080/myapp/v2/api-docs,看到返回的描述REST API的json。例如。 然后我拉入了swagger-ui依赖项

  • 我试图让我的javascript验证电话号码输入,并在用户输入信息不正确时显示消息。我还设置了另外两个输入,所以我复制了其中一个,并用phoneNumber替换了名称,但没有结果。没有HTML的替代品,请它是我必须使用我的评估。 这里我只包含了电话号码输入的代码。http://jsfiddle.net/29ZNV/ 超文本标记语言 JAVASCRIPT

  • 我正在用ASP。Net核心2.1 Web API项目。下面是一个示例控制器操作方法: 这是我在 Swagger 文档中得到的内容。如您所见,Swagger 显示属性,但不显示属性: 如果我在一个DTO类上使用< code>Required和< code>MaxLength属性,这是一个POST操作方法的参数,那么Swagger会显示这两个属性: 如何让Swagger显示查询参数的(和其他)验证属性

  • 我试图使用swagger来记录我的Restapi,并且取得了一些成功,但是在受限资源参数方面,我遇到了一堵墙。我正在使用JBoss RESTEasy与Hibernate验证器提供程序和Jackson 2.x注释的POJO。我遇到的问题是,当遇到@DecimalMin/@DecimalMax注释时,我得到一个 似乎swagger正在尝试使用较新版本的javax.validation.constrai