API/系统设计方法探讨

Question

我当时看了一段视频“设计优步api模拟面试”。

对于大多数APIs，候选程序只使用"userId“，然后留在系统上来解析"rideId”。

Example - cancelRide(userId: string)

对于这个api，用户只是将userId传递到cancelRide端点，现在系统必须解析rideId才能真正取消这个过程。

现在，这可能解决了手头的问题，但在未来，Uber可能希望为单个用户启用多个乘车(您可以同时为您自己和您的母亲预订乘车)。

有了这种API设计，我们就必须对cancelRide端点进行更改，以接受rideId。

cancelRide(userId: string, rideId: string)

如果有新的需求，或者我们至少应该考虑一些明显的/可能的未来需求/改变，我们应该根据手头的问题进行设计，并对API/Design进行更改吗？

Answer 1

你应该提前想一想:他们未来需要什么潜在的需求/改变？

原因是您正在开发一个API。

假设您的API有超过100 K的外部客户端，任何更改都会迫使它们更新、修改、重新构建它们的应用程序和大量工作。

因此，YAGNI原则不适合API设计问题。您应该尝试开放-封闭原则(OCP)。