OpenAPI 规格图

此软件包包含 jSON Schemas官方网站 每个版本的 Swagger/ OpenAPI 规格 :

所有计划都通过自动化的CI/CD工作不断更新最新的官方定义. 🤖📦

安装

您可以通过 OpenAPI Schemas 安装 无。 。 。 .

npm install @apidevtools/openapi-schemas

使用量

默认导出包含所有 OpenAPI 规格版本 :

const openapi = require("@apidevtools/openapi-schemas");

console.log(openapi.v1);    // { $schema, id, properties, definitions, ... }
console.log(openapi.v2);    // { $schema, id, properties, definitions, ... }
console.log(openapi.v3);    // { $schema, id, properties, definitions, ... }
console.log(openapi.v31);    // { $schema, id, properties, definitions, ... }

或者可以导入所需的特定版本 :

const { openapiV1, openapiV2, openapiV3, openapiV31 } = require("@apidevtools/openapi-schemas");

console.log(openapiV1);    // { $schema, id, properties, definitions, ... }
console.log(openapiV2);    // { $schema, id, properties, definitions, ... }
console.log(openapiV3);    // { $schema, id, properties, definitions, ... }
console.log(openapiV31);    // { $schema, id, properties, definitions, ... }

您可以使用 JSON Schema 验证器, 如 Z- 计划 或者说 阿联酋 根据规格验证 OpenAPI 定义.

const { openapiV31 } = require("@apidevtools/openapi-schemas");
const ZSchema = require("z-schema");

// Create a ZSchema validator
let validator = new ZSchema();

// Validate an OpenAPI definition against the OpenAPI v3.0 specification
validator.validate(openapiDefinition, openapiV31);

捐款

欢迎贡献、增强和错误修正! 打开一个问题 关于 GitHub 和 提交拉动请求。 。 。 .

大楼

要在您的计算机上本地构建工程:

1. 克隆这个还原
   git clone https://github.com/APIDevTools/openapi-schemas.git

2. 安装依赖关系
   npm install

3. 构建代码
   npm run build

4. 运行测试
   npm test

许可证

OpenAPI Schemas 是100%的自由和开放源代码, 在 麻省理工学院许可证随意使用.

这个软件包是 树件如果你把它用于生产,那么我们要求你 给世界买一棵树 感谢我们的工作。 将会为当地家庭创造就业机会.

谢谢

感谢这些优秀的公司对开源开发商的支持 QQ