当您在网络上搜索“如何构建 API”时，我发现出现了很多选项，但很少有端到端的指南。这可能是由于我的网络搜索能力差，或者因为构建 API 非常困难（从设计到生产）。

任何使用 API 的人都会告诉您，这可能是一项壮举，通常需要一个团队来管理。因此，自己构建 API 并将其投入生产以便您的用户可以开始使用它可能是一项重大挑战。

我们生活在一个幸运的时代，有许多工具使这项任务更易于管理。使用 Postman 之类的工具，我们可以创建 API 规范、测试 API 规范并最终测试我们的 API 以确保它按预期工作。要构建 API 的后端，我们将需要大量工具，例如 Flask、Heroku 等，或者我们可以选择低代码工具来构建和托管我们的 API。

在这篇文章中，我们将了解构建 API 的过程以及如何使这个过程更高效。

API开发流程

API 开发很复杂，没有办法绕过它。通常我们需要设计 API、代码、测试、调试、再次编码，再测试一些，准备好后部署，然后是看似无休止的维护。典型的 API 开发生命周期如下所示：

该过程中的每个步骤通常由另一个工具或资源完成，因此实现 API 可能会变得相当困难。

例如，我们可能会选择使用 Postman 来设计我们的 API（开放 API 规范），并使用诸如烧瓶之类的东西来连接我们的代码，连接 firebase 或一些数据库来存储或检索我们的数据。我们可能还需要对其他 API 和服务进行额外的 REST 调用。为了测试，我们可以再次使用 Postman，但是调试代码和我们所有的连接器会变得很麻烦。对于部署，我们可能会选择 Heroku，但这取决于我们的 API 需要什么。对于监控，我们可以创建我们的监控系统或使用 Splunk 之类的东西。当我们需要维护我们的 API 时，我们需要深入研究所有这些。你明白我想说的话。 API 开发很复杂。

寻找更好的方法

我想要一种方法来简化 API 开发生命周期，并只用一手工具来开发我的 API 从设计到生产。多亏了像 Linx 这样的低代码工具，这是可能的。我能够创建一个从设计到部署的 API，只使用三个工具：

Postman 我使用 postman 来创建我的 API 规范（基于 YAML）和测试我的 API
我用过的Linx灵思构建我的 API，实现逻辑，调试它，最后托管它。快速说明，您还可以尝试使用本指导教程构建 API。
SQL Server SQL Server 用于为我的 API 存储数据。我使用了预先创建的 AdventureWorks2019 数据库及其数据。

要求

我选择了一个简单的 API 来进行用户记录维护。 API 有五种方法：

创建规范

我使用符合要求的 YAML 在 Postman 中创建了一个简单的 API 规范。 Postman 让我可以看到我创建的内容并直观地提供了更多信息。在 Postman 中创建 API 定义还有利于它已经设置了用于测试的 API。如果您选择，您可以在此阶段设置测试脚本。

构建 API

现在我有了 API 定义，就可以创建代码了。 Linx 允许您导入 OpenAPI 3.0 规范，并将自动为每个指定的方法生成事件。我只需要指定 URI，然后构建逻辑。

安装数据库插件后，创建每个事件的逻辑会相对较快。 Linx 确实有一个学习曲线，就像每个工具一样，但是一旦你了解了如何使用它，速度就会加快。

我为 API 的每个事件添加了逻辑和功能。例如，对于 GetAllUsers 方法，我们都需要从 SQL 数据库中读取并通过响应体返回结果。

测试 API

因为已经在 Postman 上设置了 API，所以很容易实时测试 API 的运行方式，因为逻辑已经实现。下面的 GIF 显示了我如何使用 Linx 设计器来调试我创建的 REST API，以及我如何在调试模式下对其进行测试。

动图 API 测试

在 Linx 中调试 API 后，它被托管，以便我可以调用它来查看它在部署时的行为。这使我可以测试并获得实际结果：

当然，我们也可以在 Postman 中添加测试脚本来自动化我们的测试过程。这些脚本将确保您得到正确的响应。

部署 API

既然 API 已经设计、开发和测试过了，就需要部署它。对于传统的 API 开发来说，这可能是一项艰巨的任务，因为我们需要制定一个部署策略，弄清楚我们将在哪里托管什么，并确保监控和日志记录得到照顾等等。

我的部署非常简单。我将 Linx Designer 中的 API 直接部署到了 Linx 服务器上。构建解决方案、推送到服务器并准备好使用大约需要 2 分钟。由于 Linx 服务器会处理此问题，因此托管 API 的困难已被消除。它还进行监视和记录：

我用不正确的 ID 调用了 GetUser 方法，看看如果发生意外错误会发生什么。服务器记录错误并用红色指示发生错误：

我能够再次从 Postman 调用 API，并且每次调用 API 时服务器都会给出指示。

诚然，我没有向我的 API 添加任何形式的安全性或身份验证，但这些设置在 Linx 设计器中可用。我尝试的另一个选择是以 swagger 格式生成 API 文档。事实证明这非常有价值，因为通过将 /swagger 添加到基本 URI，文档可用并与 API 本身一起托管。这使得在需要时分发 API 文档变得容易。

包起来

当结合 Linx 和 Postman 时，我们可以设计、创建、记录和托管 API。它确实需要一点时间来适应，就像任何工具一样。因为 Linx 使用标准的编程范式和行话，所以如果您熟悉 C# 之类的编程语言，就很容易上手。我确实觉得使用 Linx 部署和托管 API 可以节省最多的时间。监控和托管已为您完成，这意味着解决了相当大的麻烦。如果日志记录和监控不够精细，您可以将功能添加到 Linx 解决方案。

如果您想尝试使用 Linx 构建 API，您可以自己尝试

使用先设计（与邮递员）或
先编码（只是建立）

也在这里发布。

将您的 API 投入生产

About Author

註釋

標籤

这篇文章刊登在

Related Stories

Light-Mode

Classic

Newspaper

Minty

Dark-Mode

Neon Noir

Minty

HN StartUps