作者: RyuGou 原文地址: RESTful API 规范（详细版） 作者公众号: 互联网技术窝 看的时候感觉写的非常不错 😆，看完自我介绍发现果然是个大佬

1. 简介

rest是一种软件架构风格，如果你们的接口是rest接口，那么就可被认为你们的的接口是 restful 的，英文名词和形容词的区别。

rest接口是围绕“资源”展开的，利用 HTTP 的协议，其实 rest 本也可以和 HTTP 无关，但是现在大家普遍的使用rest都是依托于 HTTP 协议。HTTP 的 url 即资源。

RFC 3986 定义了通用的 URI 语法：

URI = scheme “://” authority “/” path [ “?” query ][ “#” fragment ]

• scheme: 指底层用的协议，如 http、https、ftp
• host: 服务器的 IP 地址或者域名
• port: 端口，http 中默认 80
• path: 访问资源的路径，就是咱们各种 web 框架中定义的 route 路由
• query: 为发送给服务器的参数
• fragment: 锚点，定位到页面的资源，锚点为资源 id

2. RESTful API 设计

2.1 资源路径

对于 rest 资源的定义，即 URL 的定义，是最重要的；想要设计出优雅的、易读的 rest 接口，其实还是挺不容易的。

2.2 URL 中不能有动词

在 Restful 架构中，每个网址代表的是一种资源，所以网址中不能有动词，只能有名词，动词由 HTTP 的 get、post、put、delete 四种方法来表示。

2.3 URL 结尾不应该包含斜杠“/”