介绍
oas-schema-walker 是一款基于 Node.js 的 npm 包，用于遍历 OpenAPI 规范（也就是 Swagger 规范）中的各种解析器和验证器。它提供了一种方便的方式，帮助开发者遍历和检查 OpenAPI 规范中的各种元素，以保证交互性、可靠性和稳定性。
在本文中，我们将介绍如何使用 oas-schema-walker 进行 OpenAPI 规范的遍历和验证，以及它的一些高级特性和用法。
安装
oas-schema-walker 可以通过 npm 安装：
npm install oas-schema-walker
使用
在使用 oas-schema-walker 进行遍历和验证之前，我们需要先加载 OpenAPI 规范。我们可以通过如下方式完成：
const fs = require('fs');
const OAS = require('oas-schema-walker');
const oas = JSON.parse(fs.readFileSync('openapi.json', 'utf8'));
const oasWalker = new OAS();
oasWalker.walk(oas);在上面的代码中，我们首先加载 OpenAPI 规范（这里我们假设规范在 openapi.json 文件中），然后创建一个 oasWalker 对象，并调用它的 walk 方法，传入加载的规范。
接下来，我们可以调用 oasWalker 对象的各种方法，来遍历和验证 OpenAPI 规范中的各种元素。
示例
下面，我们将演示如何使用 oas-schema-walker 进行 OpenAPI 规范的遍历和验证，并进行一些实用的示例。
遍历 paths
我们可以通过 oasWalker 对象的 paths 方法，遍历 OpenAPI 规范中的所有 paths。例如：
oasWalker.paths((oasPath, pathKey) => {
// oasPath 为 path 对象，pathKey 为 path 对象的键名
console.log('path:', pathKey);
});在上面的代码中，我们使用 paths 方法遍历了 OpenAPI 规范中的所有 paths（即请求路径），并输出了每个 path 对象的键名。
遍历 operations
我们可以通过 oasWalker 对象的 operations 方法，遍历 OpenAPI 规范中的所有 operations。例如：
oasWalker.operations((oasOperation, pathKey, operationKey) => {
// oasOperation 为 operation 对象，pathKey 为 path 对象的键名，operationKey 为 operation 对象的键名
console.log('operation:', operationKey);
});在上面的代码中，我们使用 operations 方法遍历了 OpenAPI 规范中的所有 operations（即请求方式），并输出了每个 operation 对象的键名。
遍历 parameters
我们可以通过 oasWalker 对象的 parameters 方法，遍历 OpenAPI 规范中的所有 parameters。例如：
oasWalker.parameters((oasParameter, pathKey, operationKey, parameterIndex) => {
// oasParameter 为 parameter 对象，pathKey 为 path 对象的键名，operationKey 为 operation 对象的键名，parameterIndex 为参数在参数数组中的索引位置
console.log('parameter:', parameterIndex);
});在上面的代码中，我们使用 parameters 方法遍历了 OpenAPI 规范中的所有 parameters（即请求参数），并输出了每个 parameter 对象在参数数组中的索引位置。
遍历 schemas
我们可以通过 oasWalker 对象的 schemas 方法，遍历 OpenAPI 规范中的所有 schemas。例如：
oasWalker.schemas((oasSchema, schemaKey, parentSchema) => {
// oasSchema 为 schema 对象，schemaKey 为 schema 对象的键名，parentSchema 为父级 schema 对象（如果存在）
console.log('schema:', schemaKey);
});在上面的代码中，我们使用 schemas 方法遍历了 OpenAPI 规范中的所有 schemas（即请求和响应的数据模型），并输出了每个 schema 对象的键名。
验证 schemas
我们可以通过 oasWalker 对象的 validateSchema 方法，验证 OpenAPI 规范中的 schema 是否合法。例如：
-- -------------------- ---- -------
----------------------------- ---------- ------------- -- -
----- ------ - ------------------------------------
-- --------------------- - -- -
-- ------ ---
-------------------- --------- -----------
---------------------------
-
---在上面的代码中，我们首先遍历了 OpenAPI 规范中的所有 schemas，然后使用 validateSchema 方法对每个 schema 进行验证，并输出验证失败的 schema 对象的键名和错误信息。
高级特性
除了上述基本用法之外，oas-schema-walker 还提供了一些高级特性和用法，帮助开发者更加灵活地遍历和验证 OpenAPI 规范中的各种元素。
正则表达式匹配
我们可以通过 oasWalker 对象的各种方法，使用正则表达式匹配符合条件的路径、操作、参数和数据模型。例如：
-- -------------------- ---- -------
-- --- ----- -------
-------------------------- --------- -------- -- -
-------------------- ---------
---
-- ---- ------ ----
----------------------------------- -------- ------------- -- -
-- ------------- --- --------- -
------------------------- --------------
-
---
-- ------ -- -----
----------------------------------- -------- ------------- --------------- -- -
-- ------------------ --- ----- -
------------------------- ----------------
-
---
-- ------- --- -----
----------------------------- ---------- ------------- -- -
-- ------------------------- - --- -
---------------------- -----------
-
---在上面的代码中，我们使用正则表达式匹配了各种元素，找到符合条件的元素，并输出它们的键名。
处理回调函数
我们可以通过 oasWalker 对象提供的一些回调函数，处理遍历和验证的过程中所发现的各种情况。例如：
-- -------------------- ---- -------
-------------------- ------ ------------ -- -
------ ------- -
---- ---------
---------------------- -------
------
---- -------------
----------------------- --------- --------------
------
--------
------
-
---
--------------------在上面的代码中，我们先定义了一个回调函数，作为 oasWalker 对象的 on 方法的参数。当 oasWalker 对象在遍历和验证过程中发现某些事件时，就会调用这个回调函数，并将事件类型、事件的值和父级值等参数传递给它。在这个回调函数中，我们可以根据不同类型的事件，进行自定义的处理和输出。
比如，在上述代码中，我们定义了两种类型的事件：schema 和 validation。当 oasWalker 对象在遍历 OpenAPI 规范的 schema 时，就会发出 schema 事件，我们在回调函数中输出 schema 的值。而当 oasWalker 对象在验证 schema 时，就会发出 validation 事件，我们在回调函数中输出验证结果中的错误信息。
结论
通过本文的介绍，我们了解了 oas-schema-walker 这个 npm 包的基本用法和高级特性，以及如何使用它进行 OpenAPI 规范的遍历和验证。对于需要遍历和验证 OpenAPI 规范的开发者来说，oas-schema-walker 是一个非常值得尝试的工具，它能够极大地提高开发效率和维护质量。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f092556403f2923b035c018