RESTful Web API设计

框架设计原理与实战:RESTful API与Web服务 1.背景介绍 一、什么是API? API(Application Programming Interface),即应用程序编程接口。它是两个或以上软件模块之间交流信息的一种方式。通过提供的接口,外部软件可以访问由其他软件提供的某项功能或数据,从而实现各种各样的功能,如查询天气预报,网上银行业务等。API分 阅读详情

1.良好的API设计应旨在支持:
(1)平台独立性。不管API内部实现方式如何,任何客户端都应该能调用该API。这就需要使用标准协议并非创建一种机制,使客户端和web服务能够就交换数据的格式达成一致。
(2)服务演变。Web API应能在不影响客户端应用程序的使用情况下改进和添加功能。随着API的发展,现在客户端应用程序应可继续运行而无需进行任何修改。所有功能应该是可发现的,使客户端应用程序能够充分利用它。
2.什么是REST?
REST是一种基于超媒体构建分布式系统的架构风格。一种接口设计模式。REST独立于任何基础协议,不一定要绑定到HTTP。但是常见的REST API实现会使用HTTP作为基础协议。
3.基于HTTP设计RESTful API时的一些主要原则:
(1)围绕资源设计。
(2)每个资源都有一个标识符。
(3)客户端通过交换资源的表现形式来与服务交互,许多API使用JSON作为交换格式。
(4)使用统一接口,有助于分离客户端和服务的实现(包括的常见操作:GET,POST,DELETE,PUT)。
(5)无状态请求模型,无法保留请求之间的瞬时状态信息。
(6)由表示形式中包含的超媒体连接驱动。
4.Web API成熟模型
级别0:定义一个URI,所有操作是对此URI发出的POST请求。
级别1:为各个资源单独创建URI。
级别2:使用HTTP方法来定义对资源操作的执行。
级别3:使用超媒体
5.围绕资源组织API设计
设计侧重于业务实体,URI名称应基于名词,无需基于的那个物理数据项,无需让用户知道相关数据表,总之就是不让用户知道后端具体实现以及数据库内部结构。REST旨在为实体建模,以及为应用程序可对这些实体执行的操作建模,不应该将内部实现公开给客户端。
6.命名规则
引用集合的URI常用复数名词,集合和项之间有层次结构,不同类型之间相互关联:
例:/customers (获取所有用户)
/customers/5 (获取id为5的用户)
/customer/5/orders(获取id为5的用户的所有订单)
如果URI过于复杂建议按功能拆分。
在这里插入图片描述
当然URI越多,请求越多,负载越大,所以也要尽量避免大量的小型URI,可以考虑数据非规范化,尽量发少量请求获取到用户所需资源。
总之还是要在URI复杂程度,URI数量以及数据量之间权衡。
7.根据HTTP方法定义API
在这里插入图片描述
8.媒体类型
客户端和服务器交换资源的表示形式。HTTP协议中,格式是使用媒体类型(也称MIME类型)指定的。对于非二进制数据,大多数Web API支持JSON类型(媒体类型=application/json),可能支持XML(媒体类型=application/xml),请求或响应中的Content-Type标头指定表示形式的格式。如果服务器不支持媒体类型,则返回状态码415(不支持的媒体类型)。

《RESTful Web APIs》书评:API设计的卓越指南 本书《RESTful Web APIs》得到了业界专家的高度评价,被誉为学习API设计的基石。通过各领域专家的推荐语,我们能感受到这本书对RESTful API设计的深入解析和实用指导。本书由Leonard Richardson和Mike Amundsen撰写,并由知名技术专家Sam Ruby作序,旨在帮助读者理解并掌握创建RESTful Web API的技术和最佳实践。 阅读详情

相关推荐

Web接口开发与RESTful API设计源码解析

RESTful API是一种基于HTTP协议设计的API风格,其核心思想是通过统一的接口和标准的方法(如GET、POST、PUT、DELETE等)对资源进行操作。这种风格不仅简化了开发流程,还提高了系统的可维护性和可扩展性。REST(Representational State Transfer)是一种软件架构风格,最早由Roy Fielding在其博士论文中提出。它并不是一个具体的协议或标准,而是一组设计原则,用于指导开发者构建高效、可伸缩、可维护的Web服务。

weixin_31176789的博客 974

RESTful web API

一、REST名称的由来 REST是"Representational State TRansfer"的缩写,可以翻译为"表现状态转换",可以简单称为REST或者RESTful。 REST是一种“分布式超媒体应用(Distributed Hypermedia System)”的架构风格。 Hypermedia as the engine of application state 这里的应用状态 application state表示web应用的客户端状态。简单理解为会话状态。资源在浏览器中以超媒体形式呈现,通

BestpayTech的博客 800

OpenClaw的引导配置(onboard)流程

脚本安装的直接安装完到引导配置界面,其他安装方式还可以直接命令到配置。

supersolon的专栏 1328

怎样设计一个安全的web api接口?

设计一个安全的Web API接口,可以采取以下几种方法: 使用HTTPS协议:HTTPS协议可以保证数据传输的安全性,使用HTTPS协议可以避免中间人攻击和数据泄露的风险。 使用认证机制:可以使用基于用户名/密码的认证机制,或者使用令牌认证机制(比如OAuth2)来保证API接口的安全性。 对请求参数进行校验:可以对请求参数进行严格的校验,以避免恶意请求和代码执行攻击。 使用防火墙保护:可...

weixin_35750953的博客 281

STC15单片机实战项目软件开发第四讲 - 按键检测(状态机)

软件开发第四讲 - 按键检测(状态机) 一、工具链接 1、Keil c51 UV4 https://yunpan.360.cn/surl_yrIfYYmeRFk 2、STC-ISP下载软件 https://yunpan.360.cn/surl_yxH4CuUUvI3 二、学习板获取方式 方法1:自己设计PCB,自行打板焊接; 方法2:用群主设计的PCB,自行打板焊接; 方法3:向群主购买,淘宝链接...

硬件家园 3049

当今用于探测和阻止无人机的 10 种反无人机技术

利用反无人机技术应对无人机威胁。

网络研究观 3548

Web API 、Restful的好处、 微服务 学习总结

1、定义:常规的WEB API就是指使用HTTP协议通过网络调用的API; 其实就是一个WEB系统,对外提供给别人调用的API,这种调用通常是程序的方式,而不是简简单单的浏览器中输入URL访问。 像我们常规使用的WEB Service、c#的一般处理程序、WCF都属于WEB API、以及Java中的响应Ajax的Servlet都算是web api 2、使用原生H...

u010133378的专栏 2168

ESP-SR实战:从零搭建智能语音唤醒与命令识别系统

本文详细介绍了如何利用乐鑫ESP-SR框架,从零开始搭建一个完整的离线智能语音交互系统。内容涵盖硬件选型(推荐ESP32-S3与数字麦克风)、开发环境配置(ESP-IDF与ESP-ADF),并深入解析了AFE声学前端、WakeNet唤醒词检测和MultiNet命令词识别三大核心模块的工作原理与实战配置。通过具体的代码示例和调试技巧,指导开发者快速实现高识别率的语音唤醒与命令控制功能。

weixin_29161785的博客 302

解释 RESTful API,以及如何使用它构建 web 应用程序

总的来说,使用RESTful API构建web应用程序要定义资源、设计HTTP方法、实现处理程序、返回响应、考虑安全性、提供文档和版本控制,并进行测试和部署等步骤。2. 设计HTTP方法:根据资源的操作类型,选择合适的HTTP方法进行定义,如GET用于获取资源,POST用于创建资源,PUT用于更新资源,DELETE用于删除资源等。4. 返回响应:处理程序根据客户端请求的结果,返回相应的HTTP状态码和响应数据,如成功的响应可返回200状态码,错误的响应可返回400或500状态码。

qq_53976875的博客 638

5分钟搞定阿里云千问大模型API申请:手把手教你获取API Key

本文提供了一份高效的阿里云通义千问大模型API Key获取实战指南。通过清晰的步骤,帮助开发者在五分钟内完成从账号准备、精准导航控制台到创建并验证API Key的全过程,并强调了密钥安全管理和基础调用测试的重要性,助力快速集成AI能力。

ol789012345的博客 1362

电子发票二维码背后的秘密:10分钟看懂校验码、加密字符含义与防伪设计

本文深入解析电子发票二维码的结构与防伪设计,揭示校验码和加密字符的生成原理及验证方法。通过实际案例和技术细节,帮助财务人员理解电子发票的安全机制,提升防伪识别能力,确保税务合规。

weixin_29248611的博客 533

【RESTful】深入理解RESTful API:设计高效Web服务的关键

RESTful API是一种通过HTTP进行通信的应用程序接口,其设计遵循REST(表现层状态转化)架构风格。REST的核心思想是将资源视为网络上的实体,并通过统一的接口进行操作。每个资源通常通过URI(统一资源标识符)进行标识和访问。在RESTful API中,标准的HTTP方法(如GET、POST、PUT和DELETE)被用来操作这些资源。资源可以是任何可以被命名的内容,例如用户、产品、订单等。RESTful API的设计遵循一系列约定,确保客户端与服务器之间能够高效、清晰地进行交互。

人生苦短,睡觉要紧,睡醒再说 2240

避开这些坑!QMT多因子策略实盘中的5个常见错误及解决方案

本文深入剖析了在QMT平台上实施多因子策略时常见的5个错误,包括因子过拟合、数据延迟处理不当、因子失效、交易成本低估和风险控制缺失,并提供了实用的解决方案。通过优化因子筛选、数据对齐和动态管理,帮助量化交易者提升策略稳健性和实盘表现。

k5l6m的博客 240

Python 实现 Web API 的 RESTful 设计原则

REST(Representational State Transfer)是一种软件架构风格,用于设计网络服务。资源导向:API 应该以资源为中心,每个资源都有唯一的 URI。统一接口:所有操作都通过标准 HTTP 方法(如 GET、POST、PUT、DELETE 等)进行。无状态:服务器不应存储客户端的状态信息,每次请求都应包含足够的信息。可缓存性:响应可以被标记为可缓存或不可缓存。分层系统:客户端和服务器之间可以有中间层,但客户端不需要知道这些中间层的存在。按需代码。

2501_91173199的博客 1616

Pentaho安装与配置

Pentaho安装与配置前言一、下载二、配置1.JDK环境2.添加mysql-jdbc驱动三、启动 前言 Pentaho Data Integration (PDI):前身是Kettle。Pentaho提供了提取、转换和加载(ETL)功能,该功能使用统一且与最终用户和物联网技术相关且可访问的格式简化了捕获、清理和存储数据的过程。 功能:提供报表的制作、分析、仪表板、数据集成、数据采集、商业智能平台等强大功能。 一、下载 官网地址:http://www.pentaho.com/ 不过已经访问不到了

小太阳DENGJIE的博客 3623

NTscan扫描工具

ntscan是一个扫描器,可以扫描没有密码和弱密码的共享,先到配置文件中填写猜测的用户名和密码,扫描过程中右侧出现的是扫描日志。

RESTful Web API [设计篇]

《我所理解的RESTful Web API [Web标准篇]》Web服务已经成为了异质系统之间的互联与集成的主要手段,在过去一段不短的时间里,Web服务几乎清一水地采用SOAP来构建。构建REST风格的Web服务是最近两三年风行的潮流,所以很多人以为REST是一个事物。而事实却是:REST自其诞生之日起到现在(2014年)已经有14年了,它为什么叫这么一个“奇怪”的名字呢? 目录...

diaoli7779的博客 148

Probability and Statistics - 4th edition

Probability and Statistics - 4th edition

Python web实战之Django 的 RESTful API 设计详解

​ API是应用程序编程接口(Application Programming Interface)的缩写。它是一种定义了不同软件组件之间交互方式的规范。API允许不同的应用程序之间进行通信和数据交换,使得开发者能够利用其他应用程序提供的功能和数据,而无需了解其内部实现细节。 在Web开发中,API通常是用于构建和访问Web服务的一种方式。通过API,开发者可以通过HTTP请求发送和接收数据,从而实现不同应用程序之间的数据传输和交互。

Rocky006的博客 2802

复分析 阿尔福斯(Ahlfors) 第三版答案 英文

答案分为十章,有部分习题没有答案,全英文复分析阿尔福斯(Ahlfors) 第三版答案

ET2012新版免狗免安装绿色软件

ET2012新版免狗免安祖昂绿色软件。,新界面,新视觉,

上一篇: flex布局,子元素撑开父元素
下一篇: Webpack 初识
大兵的猫
博客等级 码龄7年 364粉丝 49原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

大兵的猫

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值