检测可解释为 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"
      }
    }
  }
}