如何在 Deno 中使用 Swagger？-JavaScript中文网-JavaScript教程资源分享门户

Swagger 是一个流行的 API 开发工具集，它提供了非常好的 API 文档生成和管理的功能。而 Deno 是一个新兴的 JavaScript 运行时平台，它重新设计了 JavaScript 运行时，提供了非常高效和安全的运行环境。本文介绍如何在 Deno 中使用 Swagger，并提供了示例代码。

准备工作

在开始本文中的实践之前，需要安装 Deno 和 Swagger。可以通过下面的命令来安装 Deno 和 Swagger：

# 安装 Deno
$ curl -fsSL https://deno.land/x/install/install.sh | sh

# 安装 Swagger
$ npm install -g swagger

创建 Swagger API 文档

首先，我们需要在本地创建一个 Swagger API 文档。可以使用任何文本编辑器来编辑 Swagger API 文档。本文使用 VSCode 编辑器，并安装了 Swagger 插件。创建的 Swagger API 文档的文件名为 pets.yaml。该文档定义了 /pets 路径下的 GET 请求和 POST 请求。

// javascriptcn.com 代码示例
openapi: "3.0.0"

info:
  title: Pets API
  version: 1.0.0

paths:
  /pets:
    get:
      operationId: getPets
      responses:
        "200":
          description: OK

    post:
      operationId: addPet
      responses:
        "201":
          description: Created

生成 Deno 代码

接下来，我们需要使用 Swagger 来生成 Deno 代码。可以使用以下命令来生成 Deno 代码：

$ swagger generate client -f pets.yaml -c pets -t deno

其中，-f 选项指定 Swagger API 文档的位置，-c 选项指定生成的 Deno 代码的模块名称，-t 选项指定生成的代码的目标语言为 deno。

生成的 Deno 代码包含两个文件：

pets.ts - 包含了所有定义在 Swagger API 文档中的接口函数，以及必要的请求参数和响应数据的类型定义。
fetch.ts - 包含了使用 Fetch API 发送 HTTP 请求并处理响应的封装函数。

使用 Deno 代码

最后，我们可以使用生成的 Deno 代码来发送请求并处理响应。在本文中，我们将创建一个 index.ts 文件，该文件使用 /pets 路径下的 GET 请求获取所有宠物，并使用 POST 请求添加新宠物。

// javascriptcn.com 代码示例
import { Pet, getPets, addPet } from "./pets.ts";

// 获取所有宠物
const pets: Pet[] = await getPets();

console.log("所有宠物：", pets);

// 添加一只新宠物
const pet: Pet = {
  name: "小花",
  kind: "cat",
};

await addPet(pet);

console.log("宠物添加成功！");

在命令行中执行以下命令运行代码：

$ deno run index.ts

总结

本文介绍了如何在 Deno 中使用 Swagger，并提供了示例代码。使用 Swagger 可以轻松创建并管理 API 文档，而 Deno 则提供了安全和高效的 JavaScript 运行时环境。将两者结合使用，将可大大提高开发和维护 API 的效率。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/6502a5f395b1f8cacdfe2491