npm 包 @apidevtools/openapi-schemas 使用教程

前言

OpenAPI 是一种描述 RESTful API 的规范，使得我们在设计和实现 API 时能够更加一致和有效地描述 RESTful API 的结构，以便于开发者构建 API 客户端或者服务端。在 OpenAPI 规范中，定义了 request、response、schema 等内容。由于 OpenAPI 规范促进了 API 的标准化，因此越来越多的团队加入了 OpenAPI 规范的阵营。但是，当 OpenAPI 提供更多额外的功能和校验时，不可避免会有不少的 schema 需要我们管理和维护。于是，npm 包 @apidevtools/openapi-schemas 打包来应对这样的需求。它是一个 JSON Schema 工具集，在 OpenAPI 规范下，可以用于定义和验证 JSON 文档的结构。本篇文章，将会介绍此 npm 包的详细使用方法。

安装

--- ------- ---------------------------- ------

API 详解

OpenAPI Schemas

OpenAPI Schemas 通过多个 JSON Schema 文件来描述 OpenAPI 规范提供的结构，以便于开发者验证 API 定义和对其采取相应的行动。

------ - -------------- - ---- -------------------------------

schemas

schemas 是一个对象，它包含了每个 JSON 文件中从 $ref 中导入的所有 schemas 。导入哪些 schemas 取决于 $ref，可以通过传递 options.loaders 配置项来自定义其解析方式。 schemas 使用 ijsonschema 作为规范模式的元数据验证实例，以及 ref-parser 解析库，并通过 json schema 中的 ref 属性来嵌套处理验证实例。可以通过 options 来设置 schemas 中的如下值：

  • allowUnknownKeywords：是否允许未知的关键字 (default is true)
  • allowUnusedKeywords：是否允许未使用的关键字 (default is false)
  • allowDeprecatedKeywords：是否允许使用弃用的关键字 (default is false)
----- ------- - ------------------------ -- ------- -- ----- ------ ----------
----------------------------------------- -- ----- --- --------- ----
--------------------------------------- -- ----- --- ---- ----- -- --- --------- --------- --- --------------

----------------------------- - ----- -------- --- -- ---- - ------ --------- ------- ------- - ----

validateSchema(content: SchemaObject): boolean

使用此方法验证传入的 JSON 内容是否遵循 JSON Schema 式的 API 规范，如果验证通过，则返回 true，否则返回 false。

------ - -------------- - ---- -------------------------------

----- ------- - -
  ----- ---------
  ----------- -
    ----- -
      ----- ---------
    --
    ---- -
      ----- ----------
    --
  --
  --------- ---------
--

----- ------- - ----------------------- 
--------------------- -- ----

resolve(schema: any, strict = false): Promise<any>

使用此方法，可以将指定 JSON 模式的 $ref 指向本地 URL 或网址已解析的对象的内联模式。将 strict 参数设置为 true，将强制在解析时强制验证所有模式。返回的 Promise 将解析模式，所有 $ref 指向的模式和所有自定义关键字并返回结果。

------ - ------- - ---- -------------------------------

----- ------ - -
  ----- -------------------------------------
--

--------------------------- -- -
  -- -------- ------ -- --------
---

validate(data: any, schema: any): ValidationError[]

这个方法根据指定的模式验证某个 json。如果遇到任何错误，则返回一个包含 ValidationError 实例的数组。ValidationError 实例将包含错误消息、上下文和其他详细信息。

------ - -------- - ---- -------------------------------

----- ------ - -
  ----- ---------
  ----------- -
    ----- -
      ----- ---------
    --
    ---- -
      ----- ----------
    --
  --
  --------- ---------
--
----- ---- - -
  ----- ----- -----
  ---- ---
--

----- ------ - -------------- --------
--------- -- -------------- -
  ----------------------- --------- --------
- 
---- -
  ----------------------- ---------
-

ValidationError

ValidationError 是一个可以表达用来描述 validate 方法返回错误信息的对象，构造简单，但传递的参数非常明确。

------ - --------------- - ---- -------------------------------

-- ------ -----------
----- --------------- - --- ------------------------ ------- - -------- ---- -------- -- ---------------------

-- ----------- ---- ---------
----- ------- - --- ------------------------------- ------ --------- ---------------------
------------------------------- -- --------------
----------------------------- -- ------ --------
------------------------------ -- -------------------

ValidationOptions

ValidationOptions 是一个可以用来更进一步简化 schema 验证的函数。

------ - --------------- -------- - ---- -------------------------------

----- ------ - -
  ----- ---------
  ----------- -
    ----- -
      ----- ---------
    --
    ---- -
      ----- ----------
    --
  --
  --------- ---------
--

----------------------- -- ---- ------ ---- ------- --- ------ -- -----

----- ---- - -
  ----- ----- -----
  ---- ---
--

----- ----------------- - -
  ----------- ------
  ---------------- -----
--

----- ------- - -------------- ------- ------------------
--------------------- -- ----

以上内容便是 @apidevtools/openapi-schemas 所提供的方法，其中包括 schemas、validateSchema、resolve、validate 和 ValidationError。这个工具不仅适用于 node.js 项目，也可以用于浏览器端的开发中。下面，将结合实际场景，来演示简单的使用方式。

示例

示例运行前需要先安装 node-fetch 和 yaml-parser 两个包。开一个新的目录，然后实现以下的代码：

  1. 首先新建 src 目录，然后在该目录下新建 server.yaml 文件，内容如下：

    -------- -------
-----
  ------ -------- ---------
  ------------ -- ------ --- ---- ---- - -------- -- -- --------
  -------- -------
------
  ------
    ----
      -------- ----- --- -----
      ------------ ----------
      -----
      - ------
      -----------
      - ----- -------
        --- -------
        ------------ ---- ---- ----- -- ------ -- --- ---- ---- -----
        --------- -----
        -------
          ----- ---------
          ------- -------
          -------- -
          -------- ---
      ----------
        ------
          ------------ -- ----- ----- -- -----
          --------
            -------
              ------------ -- ---- -- --- ---- ---- -- ----------
              -------
                ----- --------
          --------
            -----------------
              -------
                ----- ---------------------------
  -----------
    ----
      -------- ----- --- - -------- ----
      ------------ -------------
      -----
      - ------
      -----------
      - ----- ----
        --- ------
        --------- ----
        ------------ ---- -- -- --- --- -- ---------
        -------
          ----- --------
      ----------
        ------
          ------------ --------- -------- -- - ----- --------
          --------
            -----------------
              -------
                ----- --------------------------
    -------
      -------- -------- - ----
      ------------ -----------
      -----
      - ------
      -----------
      - ----- ---------
        --- --------
        --------- -----
        -------
          ----- --------
      - ----- ----
        --- ------
        --------- ----
        -------
          ----- ---------
      ----------
        ------
          ------------ -------- -- ---------
        ------
          ------------ ---- --- ------
-----------
  --------
    ----
      ----- --------
      ---------
      - ----
      - ------
      -----------
        ---
          ----- ---------
          ------- -------
        -----
          ----- --------
        ----
          ----- --------
    -----
      ----- -------
      ------
        ----- --------------------------

  2. 新建 index.js 文件，使用 node-fetch 和 yaml-parser 来获取 server.yaml 并进行校验。

    ------ ----- ---- -------------
------ - ----- - ---- -------
------ - --------------- -------------- - ---- -------------------------------

----- -------- ---------------- -
  ----- -------- - ----- -------------------------------------------
  ----- ---- - ----- ----------------
  ----- ------ - ------------
  ----- ------- - -----------------------
  -- ---------- -
    --------------------- ------ ----------
    -------
  -
  ------------------- ------ -- --------
-

-----------------

  3. 在终端下输入 node index.js，输出：Server schema is valid。

以上代码，使用 @apidevtools/openapi-schemas 对 server.yaml 的内容进行了校验，因此也能够运用在其他项目中。同时，它也具有很高的指导意义：使用 OpenAPI 和 JSON Schema 规范，能够使得我们更好地构建和解析 API，也能够规范化我们的 API 定义，让我们的项目更完善和严谨。

小结

本文为大家详细介绍了 npm 包 @apidevtools/openapi-schemas 的使用方式和 API。这个 npm 包使用 JSON Schema 工具集，提供了一种方便和高效的方式，用于定义和验证 JSON 文档的结构。如果你经常使用和构建 Web API，那么这个工具可能是你需要的。希望本篇文章能够为你提供帮助，感谢阅读！

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/5f329c2edbf7be33b2566dad

阅读全文

猜你喜欢

  • GraphQL：用 Connection 优化节点查询

    前言 GraphQL 是一种由 Facebook 开发的数据查询和操作语言，它提供了一种更高效、更灵活的方式来获取和操作数据。GraphQL 的一个重要特性就是可以精确地指定需要查询的数据，避免了传统...

    2 个月前
  • Server-sent Events 的浏览器支持情况及解决方法

    什么是 Server-sent Events？ Server-sent Events（简称 SSE）是一种基于 HTTP 的服务器推送技术，它可以让服务器向客户端发送事件流，客户端通过监听这个事件流来...

    2 个月前
  • ECMAScript 2020（ES11）中的新特性：BigInt 转换

    在 ECMAScript 2020（ES11）中，新增了一种数据类型：BigInt。它是一种可以表示任意大整数的数据类型，可以用来解决 JavaScript 中整数运算的精度问题。

    2 个月前
  • CSS Reset 在 IE6、IE7 等老浏览器中的应用

    什么是 CSS Reset CSS Reset 是一种通过重置浏览器默认样式的方式，消除不同浏览器之间的差异，从而实现更加一致的样式效果的技术手段。在前端开发中，使用 CSS Reset 可以让我们更...

    2 个月前
  • ES6 中的类继承和原型链之间的关系解析

    在 ES6 中，引入了 class 关键字，使得 JavaScript 也具备了面向对象编程的能力。在类继承和原型链之间，有着密切的关系。本文将详细解析 ES6 中的类继承和原型链之间的关系，并提供一...

    2 个月前
  • 如何使用 Redux 处理 React 应用中的表单数据

    前言 在开发 React 应用时，表单数据的处理是非常常见的需求。然而，由于 React 的单向数据流和组件化特性，传统的表单处理方式可能会变得非常繁琐。而 Redux 作为一种状态管理工具，可以帮助...

    2 个月前
  • Redis 处理高并发的策略

    前言 随着互联网的发展，高并发已经成为了一个不可避免的问题。而 Redis 作为一款高性能的 NoSQL 数据库，也成为了处理高并发的重要工具之一。本文将会介绍 Redis 处理高并发的策略，并且会提...

    2 个月前
  • 响应式设计中的图片适配问题解决方案

    在响应式设计中，图片适配是一个比较棘手的问题。如果不加以处理，可能会导致图片在不同设备上显示不佳，影响用户体验。本文将介绍响应式设计中的图片适配问题，并提供解决方案。

    2 个月前
  • 解析 TypeScript 中 encapsulation（封装）的实现方式

    解析 TypeScript 中 encapsulation（封装）的实现方式 在 TypeScript 中，封装（encapsulation）是一种重要的面向对象编程的特性。

    2 个月前
  • PM2 崩溃处理：如何避免由于 PM2 进程奔溃导致应用崩溃？

    在前端开发中，我们经常使用 PM2 进行进程管理和部署。但是，当 PM2 进程崩溃时，应用也会跟着崩溃。如何避免这种情况的发生？本文将介绍 PM2 崩溃处理的方法和技巧，帮助您更好地管理和部署应用。

    2 个月前
  • 在 Node.js 中运行 HTTPS 服务器的方法

    Node.js 是一个非常流行的 JavaScript 运行时环境，它可以让我们通过 JavaScript 编写服务器端应用程序。在开发 Web 应用程序时，安全性是非常重要的。

    2 个月前
  • 详解 ECMAScript 2018 中的三个新操作符及其用法

    ECMAScript 2018 (简称 ES2018) 是 JavaScript 语言的最新标准，其中包含了许多新特性和语法糖。本文将详细介绍其中的三个新操作符及其用法，分别是：扩展运算符、剩余运算符...

    2 个月前
  • 解决 Enzyme 测试 React Native 组件时动画无法渲染的问题

    在开发 React Native 应用时，我们经常需要使用 Enzyme 来测试组件。然而，当我们测试涉及到动画的组件时，我们可能会遇到一些问题：动画无法渲染，导致测试失败。

    2 个月前
  • 使用 React Router 打造复杂而强大的 SPA 应用

    随着 Web 技术的不断发展，单页应用（Single Page Application，SPA）已经成为了现代 Web 应用的主流。SPA 通过异步加载数据和动态更新页面，提供了更快速、更流畅的用户体...

    2 个月前
  • AngularJS 中如何使用 ng-repeat 中的 filter 来过滤数据

    在 AngularJS 中，ng-repeat 指令是用于循环遍历数组或对象并生成 HTML 元素的常用指令。而 ng-repeat 指令中的 filter 属性则是用于过滤数据的功能。

    2 个月前
  • 如何在 Chai 中验证 Promise.all

    如何在 Chai 中验证 Promise.all 在前端开发中，Promise.all 是一个非常常用的功能，它可以让我们在多个异步操作完成后再执行一些操作，这个功能在实际开发中非常实用。

    2 个月前
  • Mongoose 实现数据批量更新的方式详解

    前言 在前端开发中，经常会涉及到对数据库中的数据进行批量更新的操作。而 Mongoose 是一款 Node.js 平台下的 MongoDB 对象模型工具，它提供了一种方便的方式来操作 MongoDB ...

    2 个月前
  • 在使用 lit-element 的时候，如何解决麻烦的 Shadow DOM 的变量传递问题

    前言 在使用 Web Components 的时候，我们通常会使用 Shadow DOM 来实现封装和样式隔离。然而，Shadow DOM 的封闭性也带来了一些挑战，其中之一就是变量传递问题。

    2 个月前
  • Tailwind CSS 如何实现动态换肤？

    随着互联网的发展，越来越多的网站和应用开始支持动态换肤功能。动态换肤不仅可以提升用户体验，还可以让用户在不同的环境下选择适合自己的主题，增加用户黏性和满意度。本文将介绍如何使用 Tailwind CS...

    2 个月前
  • 如何在 Less 中使用字符串操作函数？

    在前端开发中，样式表是不可或缺的一部分。而 Less 是一种动态样式语言，它是 CSS 的一种扩展。在 Less 中，我们可以使用字符串操作函数来处理字符串，这些函数可以帮助我们更加方便地操作字符串，...

    2 个月前

相关推荐

    暂无文章