利用LLM增强你的API程序

大型语言模型 (LLM) 是一种旨在理解和生成类似人类文本的人工智能模型，最近以戏剧性的方式吸引了人们的注意力。包括百度、谷歌、Meta 和 OpenAI 在内的知名科技公司在过去几个月内都发布了与 LLM 相关的公告。但正是 OpenAI 于去年 11 月发布的 ChatGPT 推动了 LLM 成为主流新闻，并引发了创建下一个最佳 LLM 的竞赛。现在有越来越多的 LLM 种类可用作各种用例的强大工具，包括设计和构建 API。

LLM AI 模型分析大量文本数据以生成输出，例如自然语言、代码补全、翻译和摘要。它们在易于预测下一步的场景中效果最佳。它们非常适合完成涉及明确定义的护栏和标准实践的用例的任务，例如构建遵循API 设计优先方法的API 程序。

本文重点介绍了使用 LLM 增强 API 程序的几种方法。下次我们将介绍如何使用 API 在应用程序中启用 AI 功能 — 利用 API 实现AI。

使用 LLM 进行代码编写

提升 API 程序效率的方法之一是使用 LLM 来优化和加速 API 开发，特别是涉及代码的任务。您可以通过多种方式使用 LLM 进行代码开发，例如：

• 使用 Python、C# 或 JavaScript 等语言为 REST API 生成代码。
• 生成用于测试 API 性能的脚本。
• 根据开发人员的输入自动完成 API 代码（如在 IDE 中）。
• 检测现有 API 代码中的错误或冗余。

LLM 非常适合用于生成容易预测的内容的文本，例如基本 REST API 的代码或 API 文档的文本。例如，我要求 ChatGPT 用 Python 编写 REST API 的代码。以下是两张显示部分模型输出的屏幕截图。

许多开发人员会为他们创建的每个 REST API 重复使用相同的样板代码结构，并且经常对不同的 API 端点重复使用相同的响应。其中一些开发人员会重复使用代码来创建用于测试 API 的不同脚本。大多数（如果不是全部）开发人员都发现所有这些重复的代码工作既乏味又耗时——这非常适合 LLM！

将 AI 应用于代码可使 API 生产商受益

LLM 可以快速完成单调、重复的 API 编码任务。必须完成的单调和耗时任务越少，他们就越有时间专注于重要的问题解决。有了 AI 协助编码，开发人员将有更多空间进行创造性协作。LLM 可以为 API 编写代码，而开发人员只需根据需要审查和调整代码。AI 使开发人员能够快速测试新想法，而无需预先编写大量代码。

将 AI 应用于代码可使 API 消费者受益

API 使用者希望他们使用的所有 API 都具有一致性。他们还希望 API 能够帮助他们解决特定问题。将 AI 应用于与代码相关的任务可以让开发人员有更多时间进行创新并开发新的 API 来解决更复杂的问题。LLM 可以帮助内部利益相关者遵守 API 标准和最佳实践，例如，通过根据样式指南检查 API 代码，以便消费者最终获得他们需要的一致且有用的 API。在 LLM 的帮助下，您可以更快地构建可靠且一致的 API。

使用 LLM 进行 API 文档编写

出色的文档可帮助用户了解如何使用您的 API 并更快地进入“Hello World”。您可以使用 LLM 来确保为所有API 提供出色的文档。LLM 非常适合涉及消化和总结文本的任务。他们还擅长概述概念和通过类比解释事物。创建API 文档需要所有这些能力（尽管像Stoplight这样的工具也是一个不错的选择）。LLM 可以通过多种方式帮助您进行文档编写：

• 让 LLM 分析您的 API 源代码，然后自动生成 API 文档，以人类可以理解的方式描述其端点的功能。
• 让 LLM 审查您现有的文档，查找漏洞并提出如何填补漏洞的建议。它还可以分析您的文档，以确保内容与您当前的 API 功能相匹配。
• 如果您知道您的 API 客户在哪里遇到了问题，您可以使用 LLM 来分析代码和支持请求，然后生成相关指南，将该信息添加到您的文档或常见问题解答页面中。

一般来说，使用 LLM 可以为开发人员节省大量时间，因为他们不必手动创建他们构建的 API 的文档。说实话，大多数开发人员宁愿设计和构建 API，而不是为它们编写文档。人工智能可以比人类更快地生成一致、易读的文档。我们都知道 API 文档非常重要，但很少有开发人员有足够的时间来处理它。有了 LLM，文档就像一个简短的自然语言提示一样简单，例如“为此功能创建文档字符串”或“为此端点创建 API 参考”。

API 设计和开发的LLM：用例摘要 

• 自动生成文档：使用 LLM 根据源代码和注释自动生成或更新 API 文档。这有助于减少维护准确和最新文档所需的时间和精力。
• 代码生成：LLM 可以为不同的编程语言生成代码片段或整个 SDK（软件开发工具包），使开发人员更容易与 API 集成。
• 错误检测和解决：LLM 可以分析 API 代码以识别潜在错误、不一致或需要改进的领域，并提出可能的解决方案或优化。这可以带来更强大、更高效的 API。
• 自然语言界面：使用 LLM 为 API 创建自然语言界面，允许开发人员使用纯文本查询而不是传统的 API 调用与 API 进行交互。这些界面可以提高非技术用户的可用性和可访问性。
• 聊天机器人开发：您可以使用 LLM 开发聊天机器人，为 API 用户提供支持和指导。这些聊天机器人可以回答问题、提供故障排除帮助或提供代码示例，使开发人员更轻松地使用 API。
• API 设计优化：通过分析使用模式和开发人员的反馈，LLM 可以确定可以改进 API 设计的领域，例如简化复杂端点或添加新功能来解决常见用例。
• 教育资源：利用 LLM 创建教程、指南和其他教育资源，帮助开发人员学习如何有效地使用 API。这可以提高采用率和用户满意度。
• 社区参与：LLM 可以帮助您管理和参与开发者社区，回答论坛上的问题，生成博客文章的内容，并参与讨论以支持和推广 API。

玫瑰皆有刺：LLM注意事项

LLM 是出色的 AI 工具，但它们有时会出错，而且它们在 API 边缘情况下效果不佳。如果您打算尝试使用 LLM 编写 API 代码或文档，则需要在整个过程中有人为干预，以提示 AI 并验证其输出。您需要一名熟练的人工编辑将 LLM 生成的信息转化为 API 文档的引人注目的内容。您需要工程师检查所有 AI 生成的代码是否清晰准确。如果您将API 创建为产品，则需要关注谁使用您的 API 以及如何使用。您需要有人来主导这些对话并体谅客户，将这些互动转化为 LLM 可以执行的想法。

人类与人工智能：成功的组合

当 AI 模型和人类一起工作时，您可以加速您的 API 程序，更快地构建更好的 API，同时确保消费者拥有良好的体验。拥有法学硕士学位的人类作家或程序员可以使用强大的工具来自动完成日常任务并加速 API 设计过程。您可以使用 Stoplight 等协作 API 设计和文档工具进一步增强您的 API 程序。Stoplight 让内部和外部 API 利益相关者使用单一平台一起工作。法学硕士学位可以设置 API 来运行比赛，但只有人类才能让该 API 越过终点线。