命名API的七个良好实践它们不仅可以改善不同开发团队之间的协作并鼓励创新，还可以提高应用程序的安全性。作为两个程序或应用程序之间的连接点，API端点可以在指定服务器上资源的确切位置方面发挥作用。当客户端应用程序要向服务器发送请求信息时，我们需要使用API??；而当服务端收到请求并转入后台数据库进行查询时，也需要调用API。因此，为了让用户更方便地访问资源，获得良好的用户体验，我们需要使用高效的API来保证各个端点之间的有效通信。1.API端点如何工作？如下图所示，系统集成往往依赖于API之间的通信。通常，系统可以使用SOAP或REST等格式向API发送请求。服务端收到请求后，也会向API返回一个响应，请求资源所在的位置就是API端点。API的工作原理在端点可以处理请求之前，客户端必须提供URL、标头和文本。这里的标头包含有关请求的各种元数据，以及发送到服务器的文本详细信息。同时服务器端也可以通过连接API方式访问数据库。API端点通常使用HTTP方法，例如：GET、DELETE、PATCH或POST。这些方法决定端点的使用方式。也就是说，当客户端发送请求时，需要约定使用什么方法和URL来发起请求。当然，这些都有固定的格式供参考。相对来说，命名规则比较难，无论是API端点，网络硬件设备，还是函数和变量都被频繁使用，没有固定的规则可循。下面，我将和大家一起探讨如何命名API规范，以保证API端点能够被合理使用。7良好做法。1.使用正斜杠始终使用正斜杠来分隔URI资源。同时，斜线也有助于显示资源的层次结构。下面是一个典型的例子：https://example.com/books/authors2。动词与名词如何结合通常，名词可以用来描述资源是什么，动词用来描述资源可以做什么。因此，您应该使用动词和名词的组合来命名API资源。下面展示了一个好的API端点命名方法和一个坏的命名方法：好的命名：https://example.com/api/getBooks不好的命名：http://example.com/api/books3.使用复数名词，不要使用单数为了向用户表明您的服务器上有多个资源，您应该始终使用复数名词命名您的API端点。毕竟，如果您只使用单数名词，您可能会使用户误以为端点仅提供一种资源。下面显示了API端点命名的一种好方法和一种坏方法：好的命名：https://example.com/api/book/3糟糕的命名：http://example.com/api/books/34.避免使用全部小写字母您不应以全部小写字母键入API端点的URL，这会降低URL的整体可读性。下面显示了API端点命名的一种好方法和一种坏方法：好的命名：http://example.com/api/Books/3糟糕的命名：http://example.com/api/books/35。使用连字符分隔单词请使用连字符(-)分隔组合的单词。毕竟，连字符比驼峰式（将每个单词的首字母大写，例如：DataBaseUser）或下划线（_，有时会被遮盖）更具可读性。同时，它们也更适合SEO目的。下面展示了如何命名一个好的API端点以及什么不是。好的命名：https://example.com/api/books/33/front-cover糟糕的命名：https://example.com/api/books/33/front_cover6.不要添加文件扩展名，尽管它赢了't影响输出，但扩展名会使阅读资源变得更加困难。同时，也会大大降低资源的灵活性，不方便更换和更改扩展，甚至造成中断。下面展示了如何命名一个好的API端点以及什么不是。好的命名https://example.com/api/books不好的命名：https://example.com/api/books.xml7.版本控制如果以后要根据业务更新进行迭代，对API，您应该始终根据版本号命名您的API端点。基于此，您可以轻松区分来自两个或多个不同API版本的资源。您可以通过在端点名称之前指示正确的版本，如以下示例所示：https://example.com/api/v3/books。2。总结无论是使用新的工具还是管理现有的应用程序，API都可以为我们简化调用过程。API端点的命名和结构直接决定了API的调用性能。因此，我们有必要通过上述7大优秀实践，打造高效的API端点，为用户提供更好的体验。原文链接：https://www.makeuseof.com/api-endpoints-naming-best-practices/译者介绍JulianChen（朱利安陈），社区编辑，拥有十多年IT项目实施经验，为人不错在内外部资源和风险管控方面，重点传播网络与信息安全知识和经验。
