我们如何对 Web API 进行代码审查？
我们如何对 Web API 进行代码审查？
代码审查 意思是尝试理解一个项目的逻辑并详细分析。首先，我想将项目的手段和系统联系起来。将我们将开发的项目与我们日常生活中的系统相关联，将使我们更容易理解和开发该项目。
当我们包含在项目中时，我们将搜索如何跟踪路径的问题。
让我们有一个 Web API 项目，我们在 Web API 中开发一个新的端点。这个端点必须与项目结构兼容，并且不会破坏系统流程。
首先，我们需要通过细节来认识和理解系统，以免破坏系统流程。
1）询问问题以了解系统
Web API 系统是数字世界中的桥梁。它们将数据从一个地方传送到另一个地方，或者在不需要前端的情况下提供对数据库中存储数据的操作。
在下图中，我们看到API被定位为提供系统间数据交换的中间程序。
我们可以从提出以下问题开始开发 Web API 系统。
- 这个系统在哪里与数据库连接？
- 它对外开放数据的部分，系统的门在哪里？
- 系统对数据做了哪些操作？更新、删除或仅列出哪些？
我们问了我们的问题，我们对这个系统有意见。我们的答案将帮助我们在开发系统时做什么或在哪里做。
1) 现在拿纸和铅笔。画一些关于系统的东西
现在我们来到了可视化这些答案的部分。你不需要做专业的图纸或创建shemas。这里的目的是在我们的脑海中创造关于系统的视觉效果。
这个图像可能是你在现实生活中看到的形状。一般来说，我把项目想象成我脑海中的建筑物。建筑物的顶部是为 API 系统打开外部数据。楼中部对数据进行操作和控制，楼下连接数据库。
如果我无法获取数据，我将首先查看我连接到数据库的建筑物的中间位置。如果我无法到达任何端点，我将首先查看我编写控制器端点的建筑物顶部的位置。
2）是时候将我们自己的算法添加到系统中了
现在，我们了解了这个系统。我们对要做什么以及如何做有所了解。我们可以将自己的意见和算法添加到系统中。
系统是使用哪种架构和编程语言开发的，我们将使用该技术开发我们的算法。
一开始，我们说过让我们在 Web API 中添加一个新端点。当我们在系统中添加一个新的端点时，我们可以从这些端点中获取一个示例。我们应该详细分析系统的流程，并在不破坏流程的情况下添加我们的端点。
让我们实施到目前为止我们已经解释过的步骤 Web API 项目 .
- 首先，我们将项目克隆到本地。
- 我们正在审查项目的结构。在这里问一个问题“Web API 在哪里连接到数据库？ “。
- 代替任何数据库程序，选择了生成假数据并提供给系统的方法。我们知道我们将使用 “书桌” 班级。
- 允许我们对数据进行操作的端点定义在 “图书控制器” .我们已经知道Web API结构是怎么做的。我马上明白控制器类是我们系统的外门。
- 我了解此 Web API 的目的是列出书籍数据、获取特定书籍并添加类似这些操作的新书籍。
如果我为这个项目画一张图，就会出现如下图。
Web API 的形象在我脑海中形成。我们了解 Web API 的流程。现在，我们可以轻松地将自己的算法添加到系统中。
我们可以定义尝试在我们的脑海中创建图像的过程，我们在这里提出的所有问题，并将现有系统理解为 代码审查 .
一般来说，人们专注于学习最多的编程语言，开发最优秀的算法和使用最多的架构。是的，这些非常重要，但在第二和第三阶段。如果你不能在第一阶段正确进行系统分析，之后这个阶段无关紧要。
在学习大多数编程语言之前，您应该专注于发展您的分析才能。能不能分析系统将是软件领域最重要的事情。
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明
