OpenAPI 佐德光谱

这是一个简单的Zod Schema,用于Open API specs版本3.X.X.

先决条件

该项目需要NodeJS(第18版或以后版)和国家预防机制. 节点 财务报告和审定财务报表 国家预防机制 非常容易安装. 为了保证你的机器能提供, 尝试运行以下命令.

$ npm -v && node -v
10.2.4
v20.11.0

目录

• OpenAPI 佐德光谱
  • 先决条件
  • 目录
  • 安装
  • 使用量
    • 装入 OpenAPI 光谱
    • 升级 OpenAPI 光谱
  • 捐款
  • 版本
  • 许可证

安装

在你进来之前: 请阅读 先决条件

要安装和设置库, 运行 :

$ npm install @buildwithlayer/openapi-zod-spec

或者,如果你喜欢使用雅恩:

$ yarn add @buildwithlayer/openapi-zod-spec

使用量

装入 OpenAPI 光谱

从JSON:

import {OpenAPISpec} from '@buildwithlayer/openapi-zod-spec/index.js';
import {rawSpec} from './openapi.json';

const spec = OpenAPISpec.parse(rawSpec);

从 YAML :

import {OpenAPISpec} from '@buildwithlayer/openapi-zod-spec/index.js';
import fs from 'fs';
import yaml from 'js-yaml';

const pathToYamlFile = './path/to/openapi.yml';
const fileContents = fs.readFileSync(pathToYamlFile, 'utf-8');
const rawSpec = yaml.load(fileContents);
const spec = OpenAPISpec.parse(rawSpec);

升级 OpenAPI 光谱

import {OpenAPISpec, upgrade} from '@buildwithlayer/openapi-zod-spec/index.js';
import {oldSpec} from './openapi.json';

const upgradedSpec = upgrade(OpenAPISpec.parse(oldSpec));

捐款

这些指示将予更新 马上。 。 。 .

请阅读 捐款额 详细介绍我们的行为守则和向我们提交拉动请求的程序.

1. 叉开它!
2. 创建您的特性分支 : git checkout -b my-new-feature
3. 添加您的更改 : git add .
4. 提交更改 : git commit -am 'Add some feature'
5. 推到树枝上: git push origin my-new-feature
6. 提交拉动请求 :

版本

我们用 交换器 用于版本。 有关现有版本,见 此仓库上的标记。 。 。 .

许可证

MIT 许可证 安德烈亚·索尼