格调API的接口设计规范 Restful (格调pride)
本文目录导航:
- Restful 格调API的接口设计规范
- RESTfull接口规范了解
- 面试官:说说你对 RESTful 的了解?
- REST引见
- REST架构特色
- REST架构限度条件
- RESTful API设计规范
- 一个RESTful API案例
- 总结
Restful 格调API的接口设计规范
RESTful架构,其外围在于经过HTTP动词和URL来形容资源及其操作,成功了一种繁复高效的运行程序接口设计格调。
繁难了解,资源在URL中以名词方式展现,动词示意对资源的处置举措。
正确的设计遵照这一准则,而失误的设计则未能充沛口头此规范。
在RESTful格调中,资源被示意为URL地址中的名词,如用户、文章等,经过HTTP动词启动操作。
HTTP动词如GET用于读取资源,POST用于创立资源,PUT用于降级资源,DELETE用于删除资源。
这一设计使得接口的经常使用和了解愈加直观。
失误设计的例子通常会将操作与资源混杂,或许经常使用非规范或不明白的HTTP动词,造成接口难以了解和经常使用。
正确的设计则明晰地将动词与资源分别,经常使用规范HTTP动词启动操作,如GET恳求失掉资源,POST恳求创立资源等。
遵照RESTful规范的接口设计强调形态无反作用,即每次HTTP恳求都应该有明白的照应,并且形态应该是可预测的。
同时,设计应尽量防止经常使用全局形态,确保接口的可测试性和可保养性。
总结而言,RESTful架构经过繁复的URL和规范的HTTP动词成功了一种弱小的、可了解的接口设计格调。
遵照这一规范可以确保接口的高效、稳固和易于保养。
RESTfull接口规范了解
RESTfull架构,其外围思念在于体现层形态转移。
深刻地理解,就是资源在网络中以某种体现方式启动形态转移。
其蕴含主语“资源”,资源在网络环境中经过特定的体现方式启动交互,成功形态的转换。
RESTful架构的外围词组“Representational State Transfer”直译为“体现层形态转移”,着重强调的是资源在网络中以体现方式启动的形态转移。
详细来说,面向资源的架构(ROA)是RESTful架构的一个详细体现,它强调资源由URI(一致资源标识符)启动标识。
经过URI,咱们能够与互联网上的资源启动互动,经过调用URI启动失掉、创立、修正和删除资源的操作。
在操作资源时,咱们通经常常使用HTTP协定中的get和post恳求。
经过这些恳求,咱们可以操作资源的体现方式。
而详细的体现方式,则应当经过HTTP恳求的头消息中的Accept和Content-Type字段启动指定。
面对RESTful接口,许多人或许会感觉形象且难以了解,往往只是逗留在HTTP动词的调用上。
实践上,了解RESTful接口的关键在于了解其面前的理念:经过操作资源的体现方式来成功对资源的治理。
关于初学者,经过多看几遍关系资料,联合实践操作,能够逐渐深化了解RESTful接口的精髓。
面试官:说说你对 RESTful 的了解?
在学习RESTful格调接口之前,你或许会猎奇它能处置什么疑问,以及有什么运行场景。
实践上,随着互联网和移动设施的始终开展,Web运行的需求日益参与。
传统的灵活页面由于效率低下逐渐被HTML+JavaScript(Ajax)的前后端分别所取代。
同时,客户端的种类也产生了多元化,包括安卓、iOS、小程序等,这使得客户端和服务端之间的接口通讯变得尤为关键。
在此背景下,RESTful格调的接口因其结构明晰、合乎规范、易于了解且裁减繁难,逐渐成为盛行的选用。
RESTful是目前最盛行的接口设计规范,在许多公司中有着宽泛的运行。
例如,GitHub的API设计就是典型的RESTful API,你可以参考学习。
在通常中,虽然很多人或许仍经常使用传统API启动恳求交互,但对RESTful API的了解或许仅限于一些外表消息。
实践上,很多人或许对RESTful API存在曲解,例如,以为没有查问字符串就是RESTful API,或许经常使用了查问字符串就不是RESTful API,更误以为经常使用了JSON传输的API就是RESTful API。
本文将带你深化了解RESTful,并经过SpringBoot通常RESTful API。
在开局之前,咱们先了解一些RESTful的基本概念和特色。
REST引见
REST触及的概念性常识较多,在通常RESTful API之前,咱们须要对REST关系的常识有系统的认知。
REST的降生是为了了解和评价基于网络的运行软件的架构设计,旨在创立一个配置弱小、性能优秀、易于通讯的架构。
REST架构初次出如今2000年Roy Thomas Fielding的博士论文中,这篇论文详细引见了REST架构格调,并形容了如何经常使用REST来指点现代Web架构的设计和开发。
虽然REST并没有一个明白的规范,而更像是一种设计格调,满足这种格调的程序或接口被称为RESTful。
RESTful API就是遵照REST架构格调的接口。
REST架构特色
了解REST和RESTful的咨询与区别之后,咱们开局详细学习RESTful的一些解放条件和规定。RESTful是一种设计格调,大抵有以下几个关键特色:
REST架构限度条件
Fielding在论文中提出REST架构的六个限度条件,即RESTful设计的六大准则,规范的REST解放应满足以下准则:
RESTful API设计规范
了解了RESTful的基本规定和特性后,咱们如何设计一个RESTful API?重点思考URL门路、HTTP恳求动词、形态码和前往结果等方面。详细规范如下:
一个RESTful API案例
经过通经常识的引见,接上去咱们将经过一个案例来通常RESTful API。
在本案例中,咱们将访问实在数据库操作,创立数据库和表,经常使用SpringBoot成功RESTful格调的API。
在构建API时,须要对各种恳求有更粗疏的认知。
为了展示方便,本案例在成功时并未齐全遵照RESTful API规范,如版本号等消息。
案例更并重于经常使用SpringBoot成功接口。
案例将成功对dog资源的增删改查配置,包括非RESTful和RESTful接口的对比。
在经常使用POSTman启动发送恳求时,有三种罕用文件类型:form-data、x-www-form-urlencoded和raw,区分用于上行二进制文件、键值对数据和恣意格局文本。
总结
RESTful格调的API确实很好,但并非一切互联网公司都严厉遵照其规定设计API,由于REST只是一种格调而非解放或规定,适度现实化的RESTful API或许会付出不用要的老本。
虽然RESTful API存在一些缺陷,但当业务场景与REST格调婚配时,可以驳回RESTful格调API。
假设业务需求与RESTful格调不婚配或操作起来较为费事,也可以不驳回RESTful格调API,毕竟,无论哪种格调的API都是为了繁难团队开发、协商和治理。
经过本文的引见和通常,置信你对RESTful有了更深入的了解。
在后续的API设计中,你将能够依据实践需求启动提升。
虽然不同的人对RESTful API的了解或许不同,但其长处和特点使其成为API设计的关键选用之一,把握和了解RESTful API关于开发者来说十分关键。