显示Swagger验证信息

时间:2018-12-02 14:00:51

标签: rest api swagger

Swagger UI不显示请求参数的验证信息。 我想显示参数的最小值,最大值,格式,pattern(regex)。有人知道我如何在Swagger UI上表达参数的验证信息吗?

2 个答案:

答案 0 :(得分:0)

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

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

Learn more about Swagger UI configuration parameters.

答案 1 :(得分:0)

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