目录 1. 域名 2. 版本(Versioning) 3. 路径(Endpoint) 3. HTTP动词 4. 过滤信息(Filtering) 6. 状态码 ...
在设计接口时,有很多因素要考虑,如接口的业务定位,接口的安全性,接口的可扩展性 接口的稳定性 接口的跨域性 接口的协议规则 接口的路径规则 接口单一原则 接口过滤和接口组合等诸多因素,本篇文章将简要分析这些因素。 一 规范性建议 .职责原则 在设计接口时,必须明确接口的职责,即接口类型,接口应解决什么业务问题等 .单一性原则 在明确接口职责的条件下,尽量做到接口单一,即一个接口只做一件事,而非两件 ...
2020-02-24 10:46 0 632 推荐指数:
目录 1. 域名 2. 版本(Versioning) 3. 路径(Endpoint) 3. HTTP动词 4. 过滤信息(Filtering) 6. 状态码 ...
原文地址:https://www.jianshu.com/p/8b769356ee67 一、重要概念:REST,即Representational State Transfer的缩写。我对这个词组的翻译是"表现层状态转化"。 综合上面的解释,我们总结一下什么是RESTful架构 ...
这篇 文章主要是借鉴他人,但是自己很想总结出一套规范 一、重要概念: REST,即Representational State Transfer的缩写。我对这个词组的翻译是"表现层状态转化"。 Resource(资源) :对象的单个实例。 例如,一只动物。它可以是一段文本、一张图片 ...
1、RESTful发展背景及简介 网络应用程序,分为前端和后端两个部分。当前的发展趋势,就是前端设备层出不穷(手机、平板、桌面电脑、其他专用设备......)。因此,必须有一种统一的机制,方便不同的前端设备与后端进行通信。这导致API构架的流行,甚至出现"APIFirst"的设计 ...
网络应用程序,分为前端和后端两个部分。当前的发展趋势,就是前端设备层出不穷(手机、平板、桌面电脑、其他专用设备…)。因此,必须有一种统一的机制,方便不同的前端设备与后端进行通信。这导致API构架的流行,甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网 ...
该仓库整理了目前比较流行的 RESTful api 设计规范,为了方便讨论规范带来的问题及争议,现把该文档托管于 Github,欢迎大家补充!! Table of Contents RESTful API 设计规范 关于「能愿动词」的使用 Protocol API Root ...
域名 应该尽量将API部署在专用域名之下。 如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下。 版本(Versioning) 应该将API的版本号放入URL。 另一种做法是,将版本号放在HTTP头信息中,但不如放入URL方便和直观。Github ...
RESTful 是目前最流行的 API 设计规范,用于 Web 数据接口的设计。降低开发的复杂性,提高系统的可伸缩性。 Restful API接口规范包括以下部分: 一、协议 API与用户的通信协议,使用HTTPs协议或者HTTP协议,统一确定用一种。 二、域名 应该尽量将API部署在专用域名之下 ...