Rest API 设计原则
1.前缀主要有下面几部分组成:
api.domain.subdomain , sample:http://api.domain.subdomain
2.具体的url是后台domain层次关系的一种展现,比如下面,某个班级的某个学生
sample:http://api.domain.subdomain/classes/{id}/students/{id}
3.一般forward slash(/)后都是名词,已及它们的复数,但某些时候也有可能是动词,比如某些场景我们没法map我们的操作到标准的http method上。比如一个发短信的操作。我们可以这样设计.
http://api.domain.subdomain/students/1123/sendAlert
4.API中所包含的entity.
4.1.document, 比如下面的对应某个班级,这个class就是一个document.一般跟某个领域模型对应。
sample:http://api.domain.subdomain/class
4.2 collections 比如下面的班级复数,classes就是一个collections
sample:http://api.domain.subdomain/classes
4.3 controller,一般情况我们要尽量把我们的操作map到CRUD的http method上(post, put,delete,get),但有些情况实在没法match就只能create 一个controller.
想上面讲的给某个学生发短信,这里可以create一个sendAlert action controller.
http://api.domain.subdomain/students/1123/sendAlert
5.cache的处理
tbd
6.version的管理
tbd
分享到:
相关推荐
REST API设计原则。分标识、交互、元数据、表现等方面的设计
REST是设计分布式网络服务或API时遵循的架构原则以及设计风格, 前后端分离最佳实践的开发标准或规范。本文为资料收藏的.md笔记,选取比较重要的资料,收集了以下内容: 重要概念介绍,如前述的第2-第4个关键词。 ...
Microsoft REST API指南Microsoft REST API指南作为一种设计原则,鼓励应用程序开发人员通过RESTful HTTP接口访问资源。 为了提供尽可能流畅的体验Microsoft REST API准则Microsoft REST API准则是Microsoft内部公司...
REST API设计准则 介绍 本文档为应用程序编程接口(API)定义了一组设计准则。 本文档介绍了用于指导REST API规范的约定和设计模式,以及指导原则。 作为设计准则,此处的内容未描述特定的实现或特定的API规范。 ...
Microsoft REST API 指南 Microsoft REST API 指南作为一项设计原则,鼓励应用程序开发人员通过 RESTful HTTP 接口访问资源。 为了在遵循 Microsoft REST API 指南的平台上为开发人员提供尽可能流畅的体验,REST ...
还牢记了SOLID原则,说话者的名字和其他良好的设计习惯(很幸运,Symfony本身就是一个很好的入门书)。 大多数业务逻辑从控制器转移到相应的服务,后者又使用其他服务和Doctrine存储库来执行各种数据库查询。 就是...
RESTful架构应该遵循统一接口原则,统一接口包含了一组受限的预定义的操作,不论什么样的资源,都是通过使用相同的接口进行资源的访问。接口应该使用标准的HTTP方法如GET,PUT和POST,并遵循这些方法的语义。 如果...
这些REST的关键原则与将你的 API 分割成逻辑资源紧密相关。使用HTTP请求控制这些资源,其中,这些方法(GET, POST, PUT, PATCH, DELETE)具有特殊含义。 一旦定义好了资源, 需要确定什么样的 actions 应用它们,...
本书涵盖以下激动人心的功能: 向您介绍RESTful软件架构风格和REST API设计原则利用JSR 353 API,JSR 374 API,JSR 367 API和Jackson API进行JSON处理利用JAX-RS 2.1 API构建可移植的RESTful Web API 使用Jersey和...
REST它是一种使用URL来定位资源,使用HTTP请求描述操作的Web服务规范,本资源包含RESTful简介、设计原则、通用说明、规范细则、接口管理说明。
介绍 ...我们将从描述您应该期望的基本 JSON 有效负载开始,但也请务必查看 API 概念概述,以获取有关驱动 API 的常见主题和设计原则的更多信息。 更多详情、使用方法,请下载后细读README.md文件
关于 violines / rest-bundle是一个用于创建REST API的Symfony捆绑包。... 产品特点 请求正文或查询字符串到对象的转换 ...应用领域驱动设计原则,六边形体系结构或类似概念的现代体系结构。 安装 composer
快速开发:SpringBoot通过自动配置和约定大于配置的原则,大大简化了项目设置和开发过程。 易于扩展:SpringBoot与生俱来的灵活性使您可以轻松集成各种服务和数据库,以满足您日益增长的需求。 安全性:内置的安全...
项目的设计架构中一直提倡使用TDD(测试驱动)原则来开发,swagger-ui在这方面更是能提供很大帮助。 Swagger-UI更倾向于在线测试接口和数据,但其核心是一个javascript插件,只要稍作修改,便能按需求定制出不同...
它们考虑的系统设计原则,但使用了较少的系统理论术语。 超媒体设计可以更好地扩展,更容易更改并促进解耦和封装,以及这些带来的所有好处。 不利的一面是,它不一定是最能容忍延迟的设计,如果您不小心,缓存可能...
图书馆设计原则SDK提供了客户端功能,因此它尽可能接近Grafana REST API的请求和响应。 SDK将Grafana对象(仪表板,行,面板,数据源)映射到类似的Go结构,但并不完全遵循所有Grafana抽象。 它不使用任何记录器,...
本文档是设备管理系统第二版接口开发的设计原则,我们还在不断完善它。 Introduction 设备管理系统是一套可管理设备的短租和长租业务的系统,具有设备信息录入、设备租赁、订单管理、消息提醒等功能。我们提供一个 ...
简单性(simplicity)和灵活性(flexibility)是贯穿整个框架的设计原则。Restlet API旨在把HTTP、URI及REST的概念抽象成一系列类(classes),同时又不把低层信息(如原始HTTP报头)完全隐藏起来。
Roy Felding 在他论文 network based software architectures 的 第五章 中首次介绍了这些原则。这些REST的关键
API设计已经成熟,已经成为企业的一等公民。 我们遵循的原则和实践决定了我们 API 的可用性和整体质量。 我们已经看过有关该主题的网站和书籍,但是为什么我们需要 API 设计指南,良好的 API 设计的基本要素是什么?...