restful url 设计规范_RESTful设计方法和规范

RESTful设计方法和规范

在初步了解了 RESTful 之后，我们接到一项任务，需要为一所学校开发一套师生管理系统，客户要求所开发的系统能在 PC 桌面通过浏览器使用，而且日后还想开发 IOS 和 Android 应用。了解需求之后，我们毫不犹豫选择了前后端分离的开发模式，并且决定遵从时下最为流行的 RESTful 规范。接下来，我们就以后端开发人员的角色，一起来了解整个开发过程。

1. 域名(Domain)

根据 RESTful 规范，应该尽量使用专用的域名用于部署 API，于是我们和校方沟通，使用下方域名作为 API 访问地址：

但是经过沟通，发现上述域名已被占用，校方否决了我们的提议，考虑到 API 相对简单，于是我们使用下面地址部署 API：

上述地址中，https 代表协议名称，常见的还有 http，二者区别在于前者在传输过程中是将信息加密后传输的，而后者是明文传输；api 代表一个资源路径，可以想象成这台电脑中一个文件夹的路径。

2. 版本(Versioning)

师生管理系统不是一成不变的，日后还要更新维护。为了区分不同版本，API 的 URL 中应当包含 API 版本信息：

除了上述方法外，API 版本信息还可放在 HTTP 请求头中。Github 采用的就是这种做法。

因为不同的版本，可以理解成同一种资源的不同表现形式，所以应该采用同一个 URL。版本号可以在 HTTP 请求头信息的 Accept 字段中进行区分(参见Versioning REST Services)：

实际工作中&#x