OpenAPI 规范中的代码检查

本主题列出了 OpenAPI 规范中所有 JetBrains Rider 代码检查。

您可以在编辑器 | 检查设置 | 检查严重性 | 其他语言设置页面  Ctrl+Alt+S 上切换特定检查或更改其严重性级别。

检查	描述	默认严重性
可能的 OpenAPI/Swagger 规范候选项	检测可以解释为 OpenAPI/Swagger 规范一部分的 JSON 文件。此类文件不包含显式的规范属性，但它们被附近的主规范文件引用。以下示例包含位于同一目录中的两个文件。第一个是普通的主规范文件。第二个被第一个文件引用，因此也建议将其视为规范。主规范文件 `openapi.yaml`： openapi: 3.1.0 components: schemas: CustomSchema: description: Custom schema object properties: foo: $ref: 'common.components.json#/components/schemas/CommonSchema' 规范文件候选项 `common.components.json`： { "components": { # 'Mark file as OpenAPI specification' highlighting "schemas": { "CommonSchema": { "description": "Common schema object reused in several specifications" } } } }	警告
未解析的引用	检测 Yaml 规范文件中的未解析引用。	错误

检查

描述

默认严重性

可能的 OpenAPI/Swagger 规范候选项

检测可以解释为 OpenAPI/Swagger 规范一部分的 JSON 文件。

此类文件不包含显式的规范属性，但它们被附近的主规范文件引用。

以下示例包含位于同一目录中的两个文件。第一个是普通的主规范文件。第二个被第一个文件引用，因此也建议将其视为规范。

主规范文件 `openapi.yaml`：

openapi: 3.1.0
components:
  schemas:
    CustomSchema:
      description: Custom schema object
      properties:
        foo:
          $ref: 'common.components.json#/components/schemas/CommonSchema'

    

规范文件候选项 `common.components.json`：

{
  "components": { # 'Mark file as OpenAPI specification' highlighting
    "schemas": {
      "CommonSchema": {
        "description": "Common schema object reused in several specifications"
      }
    }
  }
}

    

警告

未解析的引用

检测 Yaml 规范文件中的未解析引用。

错误

最后修改日期： 2025年 9月 26日