@api3/ois
OIS(或作甲骨文集成规格)是一个描述API规格的JSON对象
您可以在网站上找到 OIS 的文档 文档。 。 。 .
安装
要安装 此软件包 运行 :
pnpm add @api3/ois
或者如果您使用 npm :
npm install @api3/ois --save
抓到他们了
使用被绑定的版本
我们建议使用一个固定版的OIS包,因为包中包含的验证执行OIS 版本到补丁。 固定版本还确保您的项目使用正确的OIS版本,即使有 其他软件包取决于不同的OIS版本.
确保只安装一个"zod"版本
内部,我们使用 佐德语 为OIS计划执行验证和TS打字. 当一个项目使用多个不同的zod版本时,可能会有TS问题.
使用量
OIS软件包定义了验证和TypeScript打字,可用于验证完整的OIS图案的正确性或 只是它的一部分。 例如:
const { oisSchema } = require('@api3/ois');
const possibleOis = {
// Placeholder values. Refer to the Example section below and the documentation.
oisFormat: '1.0.0',
version: '1.2.3',
title: 'coinlayer',
apiSpecifications: { ... } // omitted for brevity
endpoints: [ ... ], // omitted for brevity
};
const result = oisSchema.safeParse(possibleOis);
if (!result.success) {
throw result.error
} else {
const validOis = result.data
}
示例
可以找到一个有效的OIS的例子 这里。 。 。 .
开发者文档
释放
GitHub 动作使用 更改/行动。发布 新版本遵循这些步骤:
- 假设预期的更改出现在
main,将 GitHub PR 创建到release分支从main。 。 。 . - 合并 PR 为
release使用合并执行。 。 。 . - 这个 发布动作工作流程 将创建一个发布 PR.
- 审查发行的 PR并合并到
release使用 壁画和合并。 。 。 . - 这个 发布动作工作流程 将发布 GitHub 发布并发布软件包
npm与出处。 它还将建立一个公关,用于合并
release树枝返回到main。 。 。 . - 合并 PR 为
main从release使用合并执行。 。 。 .
请注意,发展可以继续下去 main 换言之, main 无需
保护.