什么是 OpenAPI？
OpenAPI 是一个用于定义 RESTful API 的标准，早期称为 Swagger。它使用 JSON 或 YAML 格式来描述 API 的接口和数据模型，可以帮助开发者自动生成 API 文档、客户端代码和服务端代码。
为什么要使用 OpenAPI？
使用 OpenAPI 可以提高 API 的可读性、可维护性和互操作性。通过定义规范的 API 接口和数据模型，可以方便地生成文档和代码，也可以避免出现因为接口不一致而导致的错误。
Deno 中使用 OpenAPI
Deno 是一个安全的 JavaScript 和 TypeScript 运行时环境，它可以直接执行本地文件，而无需像 Node.js 一样需要先编译成可执行文件。Deno 内置了 TypeScript 编译器和标准库，可以方便地进行开发。使用 OpenAPI 可以让我们更轻松地开发 RESTful API。
安装依赖
我们需要使用一个 Deno 的第三方库 oak 来创建 RESTful API，还需要使用一个用于解析 OpenAPI 规范的库 djwt。可以使用以下命令安装：
---- ------- ----------- ------------ ----------------------------------- ---- ------- ----------- ------------ ------------- ------------------------------
创建 OpenAPI 规范
我们可以使用任何一个 OpenAPI 规范编辑器来创建规范文件，比如 Swagger Editor。在这里我们使用 Swagger Editor 来创建一个简单的规范文件。
在 Swagger Editor 中，我们可以定义 API 的路径、方法、请求和响应的参数等信息。例如，下面是一个简单的规范文件：
-------- -----
-----
-------- -----
------ ----- ---
------
-------
----
-------- --- -----
-----------
- --- -----
----- ----
-------
----- ------
-------- -----
----------
------
------------ --
--------
-----------------
-------
----- ------
-----------
--------
----- ------这个规范文件定义了一个 /hello 的 API 路径，使用 GET 方法，可以接收一个 name 参数。当请求成功时，返回一个包含 message 属性的 JSON 对象。
生成代码
我们可以使用 djwt 库中的 generate 命令来生成代码。例如，下面的命令可以将上面的规范文件生成为 TypeScript 代码：
---- -------- ------- ------------ -------- ---------- -------- ----------
生成的 api.ts 文件中包含了所有定义的 API 接口和数据模型。
实现 API
我们可以使用 oak 库来创建一个简单的 RESTful API 服务器，然后使用生成的代码来实现 API 接口。例如，下面是一个简单的实现：
------ - ------------ ------ - ---- --------------------------------- ------ - -------- - ---- ----------- ----- --- - --- -------------- ----- ------ - --- --------- ----- --- - --- ----------- -------------------- ----- ----- -- - ----- ---- - ----------------------------------------- ----- ------ - ----- -------------- ---- --- ----------------- - ------- --- ------------------------- --------------------------------- ----- ------------ ----- ---- ---
在这个实现中，我们首先创建了一个 Application 对象和一个 Router 对象，然后创建了一个 HelloApi 对象，该对象包含了我们生成的 API 接口。最后，我们使用 Router 对象来定义 /hello 的路由，并在路由中使用 HelloApi 对象来实现 API 接口。
测试 API
我们可以使用任何一个 HTTP 客户端工具来测试 API。例如，可以使用 curl 命令来测试：
---- ------------------------------------
当请求成功时，返回一个包含 message 属性的 JSON 对象：
------------------ ------
总结
使用 OpenAPI 可以让我们更轻松地开发 RESTful API。在 Deno 中，我们可以使用 djwt 和 oak 两个库来解析 OpenAPI 规范和创建 API 服务器。通过使用 OpenAPI，我们可以提高 API 的可读性、可维护性和互操作性，从而更好地满足业务需求。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/656b46c5d2f5e1655d3ab1d1