用不到 30 行代码创建自己的 API

嘿，读者们👋🏻，在这个博客中，我们将讨论如何仅用 30 行代码创建我们自己的 API。

涵盖的主题：

什么是 API。
Tech 曾经制作过一个。
如何编码。
如何部署它（免费）。

那些都知道 API 是什么并且不想知道“如何编码”以外的任何其他内容的人，可以直接跳到该部分。

什么是 API：

API 代表应用程序编程接口 (API)，是计算机之间相互通信的一种方式。API 就像网站一样，除了 UI 部分之外，它向服务器发送请求，服务器则返回响应。

我们使用的大多数 API 都是RESTFUL API，这意味着它们遵循一组协议/规则。

你们都已经知道什么是 URL，但是 API 使用代表统一资源标识符的URI，它们有助于区分服务器上的数据。

可以有更多的终点，就像上图中的终点一样/names。

我们可以向服务器发出许多请求，但最常见的请求是：

GET：读取数据。
POST：创建新数据。
补丁：更新新数据。
删除：删除新数据。

我们已经讨论了很多有关请求的内容，现在让我们来讨论一下回应。

有一种叫做状态码的东西，它告诉你从服务器得到的响应。响应可以分为三个级别。

2** 级别（200-300）：一切正常，已获取响应。
4** 级别（400-500）：我们的请求出现了一些问题，数据未获取。
5** 级别（500+）：服务器无法发送数据。

用于制作 API 的技术：

我用过：

JavaScript
Node.JS
- Express JS
Replit（用于部署）

如何编写 API：

这将是博客中最重要的部分。

在这篇博客中，我将制作一个 API，返回电子商店中可用设备的详细信息。

const products = [
    {
      name: 'iPhone 13',
      color: 'White',
      company: 'Apple'
    },
    {
      name: 'OnePlus 9',
      color: 'Blue',
      company: 'Oneplus'
    },
    {
      name: 'iPhone 12',
      color: 'Purple',
      company: 'Apple'
    }
]

以上是我们希望 API 返回的对象。

至此，我假设你们都已经初始化了 npm 并安装了 express

npm init -y（初始化 NPM）

npm i express（安装 Express）

步骤：

步骤 1：我们必须在我们的项目中导入 express。
- const express = require('express');
第 2 步：初始化变量以调用主express()方法。
- const app = express();
步骤3：设置端口。
- const PORT = 8080;
步骤4：使用中间件将数据解析为json。
- app.use(express.json());
步骤 5：将产品对象添加到文件。

到目前为止代码如下：

const express = require('express');
const app = express();
const PORT = 8080;
app.use(express.json());

const products = [
    {
      name: 'iPhone 13',
      color: 'White',
      company: 'Apple'
    },
    {
      name: 'OnePlus 9',
      color: 'Blue',
      company: 'Oneplus'
    },
    {
      name: 'iPhone 12',
      color: 'Purple',
      company: 'Apple'
    }
]

第 6 步：让服务器监听我们的端口/启动服务器。
- app.listen(PORT, () => console.log('server is 🟢'))
- .listen()是一个函数，它启动服务器并监听分配的端口。

代码是👇🏻

const express = require('express');
const app = express();
const PORT = 8080;
app.use(express.json());

const products = [
    {
      name: 'iPhone 13',
      color: 'White',
      company: 'Apple'
    },
    {
      name: 'OnePlus 9',
      color: 'Blue',
      company: 'Oneplus'
    },
    {
      name: 'iPhone 12',
      color: 'Purple',
      company: 'Apple'
    }
]

app.listen(PORT, () => console.log(`API 🟢`))

步骤 7：创建处理请求的函数GET。
- 为此，我们有一个名为 as 的内置函数.get(resource-link, callBack-Function)

    app.get('/products', (req, res) =>{
      res.status(200).send(products)
    })

这里我们将资源链接设置为，/products这意味着用户前往时可以获取数据www.xyz.com/products。
- 在回调函数中，我们有两个参数，一个用于请求，另一个用于响应。
- 现在作为服务器，当用户发送获取请求时，我们必须响应该请求并发送数据。
- res为了同意上述观点，我们使用（响应参数）发送数据。
- 为了发送数据，我们使用.send()方法，此外我们还使用status code发送.status()。

就这样！你的 API 已经准备好了🎉，现在你可以启动localhost服务器并http://localhost:3000/products直接查看数据了。

如何免费部署您的 API：

如果我们不部署我们的 API，那么它有什么用呢？

简单来说，部署就是让你的 API 全天候运行，你可以随时使用它。

到目前为止，我假设你们都有一个 Replit 账户

步骤非常简单：

步骤 1：在 replit 帐户的 Node.JS 部分下创建一个新项目
将您刚刚编写的代码复制粘贴到文本编辑器/IDE 中。
在右侧，您将看到一个包裹部分。
- 进入其中并下载 express。
运行代码。
您会在屏幕右侧看到这样的 URI 👇🏻

现在前往链接并写入/products您创建的任何端点，您将能够看到 json 格式的数据。

非常感谢您阅读整个博客👏🏻，我真的很感激。

到那时...再见！

文章来源：https://dev.to/shreyazz/make-your-own-api-under-30-lines-of-code-4doh