API 开发者需要避免的10个错误【翻译】

随着低代码和无代码工具的出现，构建API比以往任何时候都更简单、更快。不过因为开发简单了，开发者很容易忽略一些潜在的问题，导致整个业务的下游影响。

在设计阶段多花点时间，可以确保API真正有用、安全、可扩展和稳定。

本文会讨论API开发者需要避免的10个常见错误，帮助我们开发更高质量的API。

API开发者需要避免的10个常见错误

1、API开发者的错误导致臃肿的响应

从编写代码的角度来看，调用返回整个对象，比返回特定的参数要容易得多。但问题是这种调用造成的问题大于其带来的价值。这些臃肿的响应参数对使用者毫无意义，还会影响两端的延迟和带宽。

所以需要在方法中建立灵活性，让使用者可以自由选择，是返回完整对象，或者所需的特定参数。

** 2、多个场景隔离调用**

单独的测试单个方法仅对单元测试有用，但这并不能保证同样的方法也能在应用生态系统中发挥作用。我们可以在单元测试中获得积极的结果，但在实际使用测试中会遇到错误。为避免此问题，我们需要在多个场景中运行每种方法，以确保效果。

3、不了解需要解决的问题

当需求与开发人员认为的问题之间存在脱节时，问题肯定会出现。这种不幸但常见的错误会让使用者失望，也会浪费我们的时间去返工重做。为了避免这个问题，需要评估整个工作流程以了解它是如何适应的。

4、API开发者的错误导致耗时的故障排除

当错误消息提示对消费者没有意义时，它会在两端造成不必要的工作。消费者必须花费数小时来解决问题。到最后，我们也不得不帮助他们，并最终进行一些返工以创建更有用的错误消息提示。我们需要通过准确地解释每一个错误的含义和出错的地方来创建有用的错误消息提示。此外，坚持使用众所周知的状态代码。

5、忽略可扩展性

随着时间的推移、使用量的增加，对系统提出了更高的要求。应用程序编程接口需要适当地处理需求和扩展。在设计阶段规划可扩展性可以帮助避免这个问题。

6、缺少帮助文档

当缺少帮助文档时，没人会深入使用我们新开发的应用程序编程接口。此问题会导致满意度降低和无休止的故障排除。提供解释如何使用API的综合帮助文档。确保文档保持最新；这让使用者知道如何使用任何功能。

7、输入验证不足

当我们没有在数据验证上花费足够的时间时，总会有人发现导致问题的漏洞。它可以简单到在看似无害的字段中传递无效数据。花点时间验证使用者发送的每个输入，以最小化发生这种情况的机会。

8、高轮询请求处理不当

寻找最新数据的使用者高频提出请求，容易给系统带来不必要的压力。与其让客户请求更新，不如使用webhooks之类的框架，在数据发生变化时推送更新的数据。这可以减少不必要的轮询。

9、冗余端点

冗余端点是支持和重构的噩梦。当多个端点返回相同的数据时，就会发生这种API开发的错误，因为我们需要对引用该数据的所有端点进行更新。在实施新端点以支持各种用例时，请密切关注更新，确保没有端点包含可能会重复使用的相同信息。

10、没有针对性能进行优化

发送多个请求来完成一项任务会导致延迟和带宽开销。我们可以通过将这些小请求批量处理为一次调用来优化性能。这些批量的处理请求对于想要为同一进程发送大量请求的使用者非常有用。

使用 Eolink 创建功能齐全的API

开发健全的、可扩展且有用的API并不一定很复杂。如果我们遵循一些额外的步骤并避免这 10 个容易出现的API开发错误，就可以最大限度地减少返工并创建一个提供大量价值的全功能 API。除此之外，使用Eolink这类可视化的API开发工具，也可以帮助我们快速轻松地构建 API。

图中所使用的的接口管理工具是eolink，可以对不同类型的接口进行测试，在测试流程中也支持添加不同步骤，感兴趣可以自行使用：www.eolink.com