来自 Lamao LiveAPI：构建超级便捷的 API 文档（下）

在我之前的文章中，我分享了一个由兼职学生组成的小团队如何构建 Lama2——一个简化 API 收集和执行的工具。

它很快成为我们工作流程的重要组成部分，但随着我们 API 存储库的增长，Lama2 的手动流程开始显示出其局限性。

扩大 Lama2 规模的挑战

刚开始时，我们的团队由五名学生组成，他们一边工作一边学习。

我们每天工作 3-4 小时，经常突破我们有限能力的界限。 Lama2 只是我们当时正在建设的三个项目之一。

尽管我们受到限制，Lama2 在 Hacker News 上还是受到了好评。我们甚至获得了该产品的一些早期拥护者。对于 CLI 工具和利基语言来说，这是一个可靠的回应。

但是，发布功能仍然比我们希望的要花更长的时间。当我们准备好竞争时，API 客户端市场已经很拥挤了。

全职开发类似产品的成熟团队通过他们的辛勤工作和外展活动获得了关注。虽然 Lama2 解决了实际问题，但它并没有引起我们预想的广泛关注。

我们意识到，要使 Lama2 产生真正的影响，它需要的不仅仅是执行工具。

扩大 Lama2 规模的挑战

刚开始时，我们的团队由五名学生组成，他们一边工作一边学习。

我们每天工作 3-4 小时，经常突破我们有限能力的界限。 Lama2 只是我们当时正在建设的三个项目之一。

尽管我们受到限制，Lama2 在 Hacker News 上还是受到了好评。我们甚至获得了该产品的一些早期拥护者。对于 CLI 工具和利基语言来说，这是一个可靠的回应。

但是，发布功能仍然比我们希望的要花更长的时间。当我们准备好竞争时，API 客户端市场已经很拥挤了。

全职开发类似产品的成熟团队通过他们的辛勤工作和外展活动获得了关注。虽然 Lama2 解决了实际问题，但它并没有引起我们预想的广泛关注。

我们意识到，要使 Lama2 产生真正的影响，它需要的不仅仅是执行工具。

手动 API 文档的问题

即使使用 Lama2，维护大型 API 集合也是令人畏惧的。最初，将所有服务的 API 收集到一个存储库中感觉很容易管理。但当我们扩展到四个后端和数百个 API 时，这个过程变得不堪重负。

我们亲身体会到手动记录和同步 API 更改是多么令人沮丧。我们并不孤单 — 每个开发人员在处理大型 API 集合时都面临着这一挑战。

自动化愿景

我们知道我们需要自动化工作流程，使 API 文档变得轻松且执行无缝。我们的目标是消除手动步骤并创建一个工具，该工具可以：

1. 合并代码时自动记录 API，无需设置任何类型的元标记等。
2. 每次更改时都要更新文档
3. 允许组织中的任何人轻松执行 API

我们的目标很简单：“超级方便的 API 文档。”

想象一个系统：

• 输入：存储库链接
• 输出：完整记录的 API，每次提交都会保持更新。

构建LiveAPI

为了实现这一愿景，我们开始开发 LiveAPI，这是一个具有以下主要功能的平台：

1. 一键存储库连接： 开发人员可以轻松连接他们的 GitHub、GitLab 或 Bitbucket 存储库。
2. 自动文档生成： 每次提交都会自动生成文档，并自动同步以保持最新。
3. 自动代码片段：生成任何语言的代码片段，使前端开发人员能够更快地行动。
4. 开发者友好的体验：最少的设置，最大的便利。
5. 隐私第一的 LiveAPI Runner：
   • 我们从不存储您的存储库的代码。
   • 使用我们的逻辑，我们仅提取路由和 API 验证器。
   • 整个过程在您的私人服务器上运行，确保您的数据永远不会离开您的基础设施。

传播信息

经过几个月的工作，LiveAPI 已准备就绪。我们构建了一个工具，可以减轻管理和记录 API 的痛苦，使团队能够专注于构建功能而不是争论文档。

现在，是时候与世界分享我们所创造的东西了。如果您正在寻找一款超级方便的 API 文档生成工具，让您的工作流程更加顺畅，文档编写更加轻松，请尝试一下LiveAPI。

检查一下，看看它如何改变您团队的 API 管理流程。

与我联系

我很想听听您的想法和经历。在 X 上与我联系以尽早访问并了解 LiveAPI 如何为您的组织工作。让我们一起让 API 管理变得更轻松！

以上是来自 Lamao LiveAPI：构建超级便捷的 API 文档（下）的详细内容。更多信息请关注PHP中文网其他相关文章！