RESTful API 最佳实践

2026-09-05

RESTful API 最佳实践（转）

原文:http://www.ruanyifeng.com/blog/2018/10/restful-api-best-practices.html 阮一峰老师的文章,他的文章把难懂的东西讲的易懂 RESTful 是目前最流行的 API 设计规范,用于 Web 数据接口的设计. 它的大原则容易把握,但是细节不容易做对.本文总结 RESTful 的设计细节,介绍如何设计出易于理解和使用的 API. 一.URL 设计 1.1 动词 + 宾语 RESTful 的核心思想就是,客户端发出的数据操作指令都是

我所理解的Restful API最佳实践

一直在公司负责API数据接口的开发,期间也遇到了不小的坑,本篇博客算是做一个小小的记录. 1. 不要纠结于无意义的规范在开始本文之前,我想先说这么一句:RESTful 真的很好,但它只是一种软件架构风格,过度纠结如何遵守规范只是徒增烦恼,也违背了使用它的初衷.就像 Elasticsearch 的 API 会在 GET 请求中直接传 JSON,但这是它的业务需要,因为普通的 Query Param 根本无法构造如此复杂的查询 DSL.Github 的 V3 API 中也有很多不符合标准的地

我所认为的RESTful API最佳实践

我所认为的RESTful API最佳实践不要纠结于无意义的规范在开始本文之前,我想先说这么一句:RESTful 真的很好,但它只是一种软件架构风格,过度纠结如何遵守规范只是徒增烦恼,也违背了使用它的初衷. 就像 Elasticsearch 的 API 会在 GET 请求中直接传 JSON,但这是它的业务需要,因为普通的 Query Param 根本无法构造如此复杂的查询 DSL.Github 的 V3 API 中也有很多不符合标准的地方,这也并不会妨碍它成为业界 RESTful API 的参

REST与RESTFul API最佳实践

我经常会面试一些做PHP的开发者,让我很奇怪的是,10个人总有8个多不知道什么是REST服务,甚至是没有听说过.但RESTFul API已经是现在互联网里对外开放接口的主流模式,可参考: 豆瓣API https://developers.douban.com/wiki/?title=api_v2 GitHub https://developer.github.com/v3/ 数一数年限,据我接触REST到现在也差不多有8年左右了.可能大家现在对从JavaScript客户端直接访问服务器API这种

Restful Api 最佳实践

Web APIs has become an very important topic in the last year. We at M-Way Solutions are working every day with different backend systems and therefore we know about the importance of a clean API design. Typically we use a RESTful design for our web A

RESTFul API最佳实践

RESTful API最佳实践 RESTful API 概述基本概念 REST 英文全称:Representational State Transfer,直译为:表现层状态转移.首次是由Roy Thomas Fielding在他2000年的博士论文中提出. REST是一种描述网络中client和server之间的资源交互方式. 而RESTful API就是完全遵循REST方式的一套API设计规范,简单来说,通过API来描述资源的访问方式: 通过HTTP URL描述访问什么资源通过HTTP M

Restful API 最佳实践 (理论篇)

参考: http://www.ibm.com/developerworks/cn/web/1103_chenyan_restapi/ 规划好资源标示结构和 URI模式, 是API设计成功的关键原创文章,转载请注明:http://www.cnblogs.com/ganiks/ 规划资源标识结构和URI模式规划基本资源类型针对一个文档的评论, URI 模式可以设计成如下:/ 文件夹 / [ 文件夹名 ] / 文件 / [ 文件名 ] / 评论 / [ 评论唯一标示 ] 规划集合资源类型使

RESTful API 最佳实践----转载阮一峰

文章地址http://www.ruanyifeng.com/blog/2018/10/restful-api-best-practices.html

我们必须要知道的RESTful服务最佳实践

看过很多RESTful相关的文章总结,参齐不齐,结合工作中的使用,非常有必要归纳一下关于RESTful架构方式了,RESTful只是一种架构方式的约束,给出一种约定的标准,完全严格遵守RESTful标准并不是很多,也没有必要.但是在实际运用中,有RESTful标准可以参考,是十分有必要的. 实际上在工作中对api接口规范.命名规则.返回值.授权验证等进行一定的约束,一般的项目api只要易测试.足够安全.风格一致可读性强.没有歧义调用方便我觉得已经足够了,接口是给开发人员看的,也不是给普通用户去调

ASP.NET Core Web API 最佳实践指南

原文地址: ASP.NET-Core-Web-API-Best-Practices-Guide 介绍当我们编写一个项目的时候,我们的主要目标是使它能如期运行,并尽可能地满足所有用户需求. 但是,你难道不认为创建一个能正常工作的项目还不够吗?同时这个项目不应该也是可维护和可读的吗? 事实证明,我们需要把更多的关注点放到我们项目的可读性和可维护性上.这背后的主要原因是我们或许不是这个项目的唯一编写者.一旦我们完成后,其他人也极有可能会加入到这里面来. 因此,我们应该把关注点放到哪里呢? 在这一份指

RESTful服务最佳实践

本文主要读者引言 REST是什么统一接口基于资源通过表征来操作资源自描述的信息超媒体即应用状态引擎(HATEOAS) 无状态可缓存 C-S架构分层系统按需编码(可选) REST快速提示使用HTTP动词表示一些含义合理的资源名 XML和JSON 创建适当粒度的资源考虑连通性定义幂等性安全 HTTP动词 GET PUT POST PUT和POST的创建比较 DELETE 资源命名资源URI示例资源命名的反例复数返回表征资源通过链接的可发现性(HATEOAS续)

RESTful服务最佳实践(转）

原文:https://www.cnblogs.com/jaxu/p/7908111.html 译文作者:Jaxu 英文原文:https://files-cdn.cnblogs.com/files/jaxu/RESTful_Best_Practices_v1_2.pdf 本文主要读者该最佳实践文档适用于对RESTful Web服务感兴趣的开发人员,该服务为跨多个服务的组件提供了较高的可靠性和一致性.按照本文的指导,可快速.广泛.公开地为内外部客户采用. 本文中的指导原则同样适用于工程师们,他们希

[转]ASP.NET Core Web API 最佳实践指南

原文地址: ASP.NET-Core-Web-API-Best-Practices-Guide 转自介绍# 当我们编写一个项目的时候,我们的主要目标是使它能如期运行,并尽可能地满足所有用户需求. 但是,你难道不认为创建一个能正常工作的项目还不够吗?同时这个项目不应该也是可维护和可读的吗? 事实证明,我们需要把更多的关注点放到我们项目的可读性和可维护性上.这背后的主要原因是我们或许不是这个项目的唯一编写者.一旦我们完成后,其他人也极有可能会加入到这里面来. 因此,我们应该把关注点放到哪里呢? 在

js-新兴的API,最佳实践,离线应用于客户端存储

离线应用于客户端存储: 1.离线检测:online以及offline事件,都是在window对象上触发 navigator.online为true的时候是表示设备能够上网 2.使用一个描述文件(manifest file)列出要下载以及缓存的资源 <html manifest ="/offline.manifest"> 3.描述文件中的核心是applicationCache对象,该对象有一个status属性,属性的值是一个常量 0:无缓存 1:闲置-应用缓存未得到更新 2:

Swagger2在DBA Service中生成RESTful API的实践

目的与背景: 目的:对外暴露DBA Service必要的RESTful API,形成规整的API文档背景:DBA Service后端采用Spring-boot,属于Spring家族,故生成API的工具采用基于Swagger2实现的SpringFox-Swagger2 一.API在线生成配置 1.通过Maven引入springfox-swagger2和 springfox-swagger-ui两个依赖,如下: <dependency> <groupId>io.springfox&l

转：使用Android API最佳实践

原文来自于:http://blog.jobbole.com/65170/ 写在前面现在,Android应用程序中集成第三方API已十分流行.应用程序都有自己的网络操作和缓存处理机制,但是大部分比较脆弱,没有针对网络糟糕情况进行优化.感谢Square lnc 这家有创新精神的公司,将信用卡商业交易带到手机上.现在有了一系列高质量开源库,支持在Android应用程序中集成. 做什么,如何做? 现在,我们要依次学习使用Retrofit.OKHttp和GSON,简单快速的集成REST API.使用这个

【SpringMVC】SpringMVC系列15之SpringMVC最佳实践

15.SpringMVC最佳实践 15.1.遵循Restful API最佳实践参考:http://segmentfault.com/a/1190000002949234 15.2.统一返回字段 15.3.统一错误处理 15.3.1.web容器统一错误页面 15.3.2.业务统一错误处理 15.4.统一日志处理 15.5.统一国际化处理 15.5.1.格式化返回 15.5.2.语言切换 16.附录尚硅谷资料.文档.视频.软件包等:http://www.atguigu.com/opensourc

RESTful API接口文档规范小坑

希望给你3-5分钟的碎片化学习,可能是坐地铁.等公交,积少成多,水滴石穿,谢谢关注. 前后端分离的开发模式,假如使用的是基于RESTful API的七层通讯协议,在联调的时候,如何避免配合过程中出现问题?这里分享一些不成熟的浅见. Swagger描述我们在前后端配合的过程中,使用了大多数人使用的Swagger作为服务描述文档,这样的好处很明显,就是后台编写注释,接口调用界面自动生成字段描述.如下图: 随着前后端磨合,默契程度逐步增加,基本上这种描述文档足够联调了.事物总是多变的,随着新人的加入

前后端分离与 restful api

为什么要前后端分离(优点): PC,APP,PAD 多端适应单页面应用(Single Page Application)SPA开发模式开始流行前后端开发职责不清开发效率问题,前后端互相等待前端一直配合着后端,能力受限后台开发语言和模板高度耦合,导致开发语言依赖严重前后端分离缺点: 前后端学习门槛都增加数据依赖导致文档重要性增加,文档很重要在前后端分离模式中搜索引擎优化SEO(Search Engine Optimization)的难度增大后端开发模式迁移成本增加 restful

Spring Boot 2.x 编写 RESTful API (一) RESTful API 介绍 & RestController

用Spring Boot编写RESTful API 学习笔记 RESTful API 介绍 REST 是 Representational State Transfer 的缩写所有的东西都是资源,所有操作都通过对资源的增删改查 (CRUD) 实现对资源的增删改查对应对 URL 的操作 (POST, DELETE, PUT, GET) 无状态的 URL 中都应该是名词,不应该出现动词关于 RESTful API 更详细可参考阮一峰老师的 RESTful API 最佳实践 RestContro

RESTful API 最佳实践

热门专题