介绍
swagger-analyzer 是一个用于分析 Swagger 文档的 npm 包。通过使用该包，我们可以对 Swagger 文档进行有效的校验，以确保其符合规范，同时也能够进行一些其他的检查以提高文档的质量。本文将详细介绍在项目中使用 swagger-analyzer 的方法，并提供一些示例代码。
安装
使用 npm 安装：
npm install -g swagger-analyzer
使用
命令行使用
在命令行中使用，可以通过以下命令来分析 Swagger 文档：
analyzer [path-to-swagger-file]
例如：
analyzer ./swagger.yml
API 使用
在项目中引入该包并使用，可以通过以下方法进行分析：
-- -------------------- ---- -------
----- -------- - ----------------------------
----- -------- - --- -----------
-------------------------------------------------- --------
------------ -- -
--------------------
--
------------ -- -
---------------------
---该方法将返回一个 Promise，在 Promise 的 then 中可以获取分析的结果，catch 中可以获取错误信息。
配置
该包可以通过配置文件进行一些自定义的配置。默认情况下，该包会检查 Swagger 文档的一些基本规范，如标准的 HTTP URL、认证信息等。你可以通过配置文件来指定更多的规则或者关闭默认规则。
配置文件的默认路径为 ./analyzer.config.js。如果想要指定其他的配置文件路径，可以通过 CLI 参数或者 API 参数来指定。
配置文件格式如下：
module.exports = {
extends: ['base'],
rules: {
'additional-properties': 'warn'
}
};规则
该包内置了许多规则，可供使用。你也可以自定义规则。下面是一些常用规则的介绍：
- additional-properties：对象的属性是否可以有未定义的属性。默认为
true。 - api-path-begin-slash：API 路径是否以
/开始。默认为true。 - api-path-end-slash：API 路径是否以
/结束。默认为false。 - api-path-evaluate-params：API 路径中的参数名称是否注明。默认为
true。
示例代码
下面是一个使用 swagger-analyzer 库分析 Swagger 文档的示例代码：
-- -------------------- ---- -------
----- -------- - ----------------------------
----- -------- - --- -----------
-------------------------------------------------- --------
------------ -- -
--------------------
--
------------ -- -
---------------------
---在该示例中，我们通过 require 引入了 swagger-analyzer 库，并使用了该库的 validate 方法来进行 Swagger 文档的校验。该方法将返回一个 Promise，在 Promise 的 then 中可以获取分析的结果，catch 中可以获取错误信息。
同时，我们可以使用配置文件修改校验的规则，例如：
module.exports = {
extends: ['base', 'eslint:recommended'],
rules: {
'additional-properties': 'warn'
'api-path-evaluate-params': 'off'
}
};在该文件中，我们通过 extends 属性引用了 pre-defined 规则，同时也使用了自定义规则。在上面的示例中，additional-properties 规则设为了 warn，即产生警告而非错误；api-path-evaluate-params 规则设为了 off，即关闭该规则。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005528881e8991b448d0015