What are the top 10 mistakes API developers should avoid?

本文共计1493个文字，预计阅读时间需要6分钟。

随着低代码和无代码工具的兴起，构建API的过程变得更加简单快捷。不过，由于开发变得简单，开发者很容易忽略潜在的问题，这可能导致整个业务的下滑。在设计阶段，多花时间在细节上至关重要。

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

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

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

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

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

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

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

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

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