为遗留应用程序构建API和SDK的最佳实践

Question

我的任务是承担一个遗留应用程序(该应用程序在用户体验方面的API非常差，大部分没有文档，执行缓慢)，并构建一个新的API和SDK来改进用户体验。我可以访问这个遗留应用程序的源代码，我只能看到一个完成所有任务的端点。

我想知道包装新API的最佳方法，它可以改善遗留应用程序的用户体验。以下是我想过的一些事情：

1. 设计API，使其遵循REST原则
2. 使用RAML/Swagger等工具记录API
3. 改进API的用户体验，以便他们能够更容易地输入查询数据，例如在JSON有效负载中指定查询数据，而不是作为URL中的查询参数(与遗留应用程序一样)
4. 生成查询所有排列的测试，从而尽可能多地执行底层遗留服务。
5. 某种回归测试框架，以确保新的API不会破坏遗留应用程序的工作以外的限制。

困扰我的一件事是如何最好地与遗留One服务进行通信？我必须将JSON从我的webservice转换为一个遗留API接受的查询。围绕这一点的最佳实践是什么？

任何其他的建议，我已经错过了，将不胜感激。

Answer 1

在那之前

• 将分析添加到遗留api (或者分析web日志，这应该很容易，因为它是基于参数的)
• 寻找最流行的用例和次优方法(如果客户经常一个接一个地执行两个相同的操作，也许应该捆绑它们)。
• 查找流行的查询并检查哪些应该/可以缓存
• 坐下来设计新的API围绕这个发现。

另外，有时compnies想要构建特殊的解决方案，用新的解决方案来使用他们的遗留系统，但是他们忘记了，仅仅通过一个完整的新解决方案直接访问遗留解决方案的DB有时更容易和/或更多未来的证据。