以前开发或更新 API 时，我们经常需要深入讨论对 API 的结构、命名和功能等，这个花费了大量的时间。
随着 API 行业的蓬勃发展，API 设计也越来越重要。这么多年发展下来，一些如REST API之类的规则也受到大多数人认可，这些规则可以应用于开发流程中，帮助团队快速达成共识，达到提效的目的。
接下来会介绍 API 设计的原理和规则。而在本文中，我们将专注于 Web API。
先用一句话来解释一下，API 是 Application（应用程序）、Programming（编程）和 Interface（接口）的缩写组合，顾名思义，通过一个编写好的接口，连接两个应用程序，可以内部使用，也可以对外开放。
基本上，每次我们使用 Web 应用程序、发送消息或访问某个 URL 时，都在使用对应的 API ，无论它是客户端应用程序还是服务器应用程序，都是通过 API 来传递数据。
由于 API 和其他一切之间的所有通信都是通过 HTTP 完成的，因此 HTTP 非常重要，需要根据不同的目的和需求，采用不同的请求方法：
GET — 请求指定资源的表示。使用 GET 的请求应该只检索数据。
POST — 向指定资源提交数据。
PUT — 用请求数据替换目标资源的所有当前表示。
DELETE — 删除指定的资源。
PATCH — 对资源应用部分修改。
具体的用法可以在公众号其他文章中了解，网上也有很多相关的内容，就不过多展开。
开发技术在不断发展，API 架构和协议也越来越多。不同的架构和协议，在制定数据类型、命令方式、功能上都有所不同。以前最流行的是基于 XML 的协议，现在也逐渐被 JSON 取代。
而当今世界上最常见的 API 架构毫无疑问是 REST 。当我们使用 REST API 时，必须遵循 JSON 的规范，以有效的 JSON 格式发出测试请求。好的 API 通常会遵循这些规则：
API 必须与后端、数据存储、客户端等分开。考虑到安全性和灵活性，API 必须是单独的层级；
不同的请求应该互不干扰，独立处理。这也意味着每个请求都需要包含处理它所需的所有信息；
API 应该独立于客户端外发送请求，以相同的方式工作。例如在 Web 服务器、负载平衡器还是任何其他客户端；
资源应该在客户端或服务器端应该是可缓存的。这可以提高客户端的性能，同时提高服务器端的可拓展性；
处理错误并返回相应的错误代码。帮助用户了解是404还是其他问题；
API 必须是有容错的。用户有时因为物理原因如网络超时等，发出了重复的请求，这样的请求应该返回相同的结果；
使用 Eolink 或其他工具生成规范的 API 文档。不管是使用还是工作交接，都需要用到 API 文档。
命名端点也有一些很好的方式：
只使用名词：端点应该用指定资源内容的名词命名，而不是为正在执行的功能添加动词。例如命名端点 /users 并使用不同的 HTTP 方法来处理用户实体，而不是创建多个 /get-user 、/add-user 等端点；
使用清晰的名称：端点的名称应该清晰直观。不要使用任何快捷方式或缩写，除非很明显 - /ids 是可以理解的并且比 /identification-numbers 更可取；
通过正斜杠构建层次结构：将端点分组为逻辑组。如 /departments/ids 和 /departments/managers ，比 /departments-ids 和 /departments-managers 更好；
仅使用小写：URL 是区分大小写的，因此最好尽量避免使用大写；
使用“-”分隔单词：端点名称中的不同单词通常用“-”分隔，而不是下划线或骆驼拼写法；
避免使用特殊字符：URL 只能使用 ASCII 字符集发送和接收，因此可以只使用该字符集中的字符。同时其他如“%”，“[]”，“{} ”,“|”,“,”“<>” 最好也尽量避免使用。
大多数 REST API 是与微服务架构一起制作的。
在这种情况下，这种 API 结构将提供更改底层逻辑、添加或删除组件等的灵活性，而无需更改与其他服务的其他通信协议。
相信你也对 Web API 的设计有了一定的了解了，这是无数人验证过的合理的优秀的方案，尝试一下应用到工作中吧！
图中所使用的的接口管理工具是eolink，感兴趣可以自行使用：www.eolink.com
我正在使用i18n从头开始构建一个多语言网络应用程序，虽然我自己可以处理一大堆yml文件，但我说的语言(非常)有限，最终我想寻求外部帮助帮助。我想知道这里是否有人在使用UI插件/gem(与django上的django-rosetta不同)来处理多个翻译器，其中一些翻译器不愿意或无法处理存储库中的100多个文件，处理语言数据。谢谢&问候，安德拉斯(如果您已经在rubyonrails-talk上遇到了这个问题，我们深表歉意) 最佳答案 有一个rails3branchofthetolkgem在github上。您可以通过在Gemfi
我有一个模型:classItem项目有一个属性“商店”基于存储的值，我希望Item对象对特定方法具有不同的行为。Rails中是否有针对此的通用设计模式？如果方法中没有大的if-else语句，这是如何干净利落地完成的？ 最佳答案 通常通过Single-TableInheritance. 关于ruby-on-rails-Rails-子类化模型的设计模式是什么？，我们在StackOverflow上找到一个类似的问题： https://stackoverflow.co
我将应用程序升级到Rails4，一切正常。我可以登录并转到我的编辑页面。也更新了观点。使用标准View时，用户会更新。但是当我添加例如字段:name时，它不会在表单中更新。使用devise3.1.1和gem'protected_attributes'我需要在设备或数据库上运行某种更新命令吗？我也搜索过这个地方，找到了许多不同的解决方案，但没有一个会更新我的用户字段。我没有添加任何自定义字段。 最佳答案 如果您想允许额外的参数，您可以在ApplicationController中使用beforefilter，因为Rails4将参数
我有用于控制用户任务的Rails5API项目，我有以下错误，但并非总是针对相同的Controller和路由。ActionController::RoutingError:uninitializedconstantApi::V1::ApiController我向您描述了一些我的项目，以更详细地解释错误。应用结构路线scopemodule:'api'donamespace:v1do#=>Loginroutesscopemodule:'login'domatch'login',to:'sessions#login',as:'login',via::postend#=>Teamroutessc
在应用开发中，有时候我们需要获取系统的设备信息，用于数据上报和行为分析。那在鸿蒙系统中，我们应该怎么去获取设备的系统信息呢，比如说获取手机的系统版本号、手机的制造商、手机型号等数据。1、获取方式这里分为两种情况，一种是设备信息的获取，一种是系统信息的获取。1.1、获取设备信息获取设备信息，鸿蒙的SDK包为我们提供了DeviceInfo类，通过该类的一些静态方法，可以获取设备信息，DeviceInfo类的包路径为：ohos.system.DeviceInfo.具体的方法如下：ModifierandTypeMethodDescriptionstatic StringgetAbiList()Obt
我正在使用Mandrill的RubyAPIGem并使用以下简单的测试模板:testastic按照Heroku指南中的示例，我有以下Ruby代码:require'mandrill'm=Mandrill::API.newrendered=m.templates.render'test-template',[{:header=>'someheadertext',:main_section=>'Themaincontentblock',:footer=>'asdf'}]mail(:to=>"JaysonLane",:subject=>"TestEmail")do|format|format.h
目录前言滤波电路科普主要分类实际情况单位的概念常用评价参数函数型滤波器简单分析滤波电路构成低通滤波器RC低通滤波器RL低通滤波器高通滤波器RC高通滤波器RL高通滤波器部分摘自《LC滤波器设计与制作》，侵权删。前言最近需要学习放大电路和滤波电路，但是由于只在之前做音乐频谱分析仪的时候简单了解过一点点运放，所以也是相当从零开始学习了。滤波电路科普主要分类滤波器：主要是从不同频率的成分中提取出特定频率的信号。有源滤波器：由RC元件与运算放大器组成的滤波器。可滤除某一次或多次谐波，最普通易于采用的无源滤波器结构是将电感与电容串联，可对主要次谐波（3、5、7）构成低阻抗旁路。无源滤波器：无源滤波器，又称
项目介绍随着我国经济迅速发展,人们对手机的需求越来越大,各种手机软件也都在被广泛应用,但是对于手机进行数据信息管理,对于手机的各种软件也是备受用户的喜爱小学生兴趣延时班预约小程序的设计与开发被用户普遍使用,为方便用户能够可以随时进行小学生兴趣延时班预约小程序的设计与开发的数据信息管理,特开发了小程序的设计与开发的管理系统。小学生兴趣延时班预约小程序的设计与开发的开发利用现有的成熟技术参考,以源代码为模板,分析功能调整与小学生兴趣延时班预约小程序的设计与开发的实际需求相结合,讨论了小学生兴趣延时班预约小程序的设计与开发的使用。开发环境开发说明：前端使用微信微信小程序开发工具：后端使用ssm：VU
我正在尝试使用Ruby2.0.0和Rails4.0.0提供的API从imgur中提取图像。我已尝试按照Ruby2.0.0文档中列出的各种方式构建http请求，但均无济于事。代码如下:require'net/http'require'net/https'defimgurheaders={"Authorization"=>"Client-ID"+my_client_id}path="/3/gallery/image/#{img_id}.json"uri=URI("https://api.imgur.com"+path)request,data=Net::HTTP::Get.new(path
Rails相对较新。我正在尝试调用一个API，它应该向我返回一个唯一的URL。我的应用程序中捆绑了HTTParty。我已经创建了一个UniqueNumberController，并且我已经阅读了几个HTTParty指南，直到我想要什么，但也许我只是有点迷路，真的不知道该怎么做。基本上，我需要做的就是调用API，获取它返回的URL，然后将该URL插入到用户的数据库中。谁能给我指出正确的方向或与我分享一些代码？ 最佳答案 假设API为JSON格式并返回如下数据:{"url":"http://example.com/unique-url"
