一个好的API设计，是应该遵循资源导向的，需要见名知义。
如何命名URL？命名字段？
例如：/users 一组用户（使用复数名词）
/users/id 表示具有关于指定用户的信息的资源。
资源，始终应该是URL中的复数。动词，不适合资源网址。
非资源的，可以使用动词，这种情况下，你的API不会返回任何资源，而是执行一个操作并将结果返回客户端。
通过名词和动词来区分资源与操作，是个不错的选择。
请求的参数和响应的类型，尽量是JSON格式的，遵循字段驼峰格式。
公开的资源，不应该出现数据库的表名和字段名。
合理的使用HTTP方法？
一些简单的API设计规则，你有遵守过吗？大部分情况，不是我们不会，而是太懒了
APIs（此图来自网络）
你应该避免使用：/addUser 或者 /updateUser。 也应该避免发送资源操作作为参数，例如： ?method=add
正确的姿势，应该是通过HTTP方法来解释功能：
GET 用于检索资源
POST 用于创建新的资源和子资源（一个资源与另一个资源有关系的资源）
PUT 用于更新现有资源
PATCH 也是用于更新现有资源的，但是仅更新所提供的字段。
DELETE 用于删除现有资源
上边这些方法，很少有接口的人员是这样用的。大部分为了简单，只是：GET和POST。
怎么使用子资源呢？
首先，它是用于将一个资源与另一个资源链接，这个关系就是子资源。因此，API体现出来，就达到了见名知义的目的了。
例如： GET /schools/北京大学/students 表示获取北京大学里的所有学生名单。
GET /schools/北京大学/students/那些曾经放任的时光 表示从北京大学获取指定学生“那些曾经放任的时光”的信息。
POST /schools 表示创建一所新学校，并返回创建的信息。
如何控制API的版本？
一些简单的API设计规则，你有遵守过吗？大部分情况，不是我们不会，而是太懒了
API RESTful （此图来自网络）
当你的API提供给第三方公开时，升级API会出现一些不可预测的变化，很可能会造成产品或者服务的破坏。因此，你需要在API的URL中体现出来版本。
网络应用程序，分为前端和后端两个部分。当前的发展趋势，就是前端设备层出不穷（手机、平板、桌面电脑、其他专用设备......）。因此，必须有一种统一的机制，方便不同的前端设备与后端进行通信。这导致API构架的流行，甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。
资源 （Resources）URI (Uniform Resource Identifiers) 统一资源标示符
URI = scheme "://" authority "/" path [ "?" query ] [ "#" fragment ]
URI规范：
URI不包含动词，使用名词复数。
URI不使用大写。
URI层级不要太深。
URL(Uniform Resource Locator) 统一资源定位符(URI的实现)
表现（Representation）
HTTP请求的头信息中，用Accept和Content-Type标示。
HTTP动词
对于资源的具体操作类型，由HTTP动词表示。
常用的HTTP动词有下面五个（括号里是对应的SQL命令）。
GET（SELECT）：从服务器取出资源（一项或多项）。
POST（CREATE）：在服务器新建一个资源。
PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。
DELETE（DELETE）：从服务器删除资源。
还有两个不常用的HTTP动词。
HEAD：获取资源的元数据。
OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。
restful api 一些例子:
GET /zoos：列出所有动物园
POST /zoos：新建一个动物园
GET /zoos/ID：获取某个指定动物园的信息
PUT /zoos/ID：更新某个指定动物园的信息（提供该动物园的全部信息）
PATCH /zoos/ID：更新某个指定动物园的信息（提供该动物园的部分信息）
DELETE /zoos/ID：删除某个动物园
GET /zoos/ID/animals：列出某个指定动物园的所有动物
DELETE /zoos/ID/animals/ID：删除某个指定动物园的指定动物
过滤信息
如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。下面是一些常见的参数。
?limit=10：指定返回记录的数量
?offset=10：指定返回记录的开始位置。
?page=2&per_page=100：指定第几页，以及每页的记录数。
?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
?animal_type_id=1：指定筛选条件
参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如，GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。
常见异常返回码
200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
204 NO CONTENT - [DELETE]：用户删除数据成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。
异步任务
由于互联网通信 高延时（high latency）、高并发等特点 异步任务派上大用场。
先返回任务创建成功
客户端轮询任务状态