首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >专栏 >REST服务与RestfulAPI风格

REST服务与RestfulAPI风格

作者头像
98k
发布于 2019-10-21 02:57:10
发布于 2019-10-21 02:57:10
58600
代码可运行
举报
文章被收录于专栏:Django ScrapyDjango Scrapy
运行总次数:0
代码可运行

解决当前各系统间接口规范不统一问题

需要版本号(ansible接口建议新老版本间用版本号区别)

post get delete update up 只用post get

返回用json格式

基本返回值

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
{
    "code": 500, 200 , 404,
    "msg": "Something bad happened",
}
  • api 接口必须加版本号,初始版本 【v1】,多个版本api版本可能同时在线
  • 不使用rest的PUT和DELETE,因为很多浏览器不支持,很多框架也不支持
  • POST在需要传输大量数据的时候使用,其余使用GET就可以了 参数数量和长度给一个值
  • 所有路径path全部小写,以下划线分隔,所有参数,包括POST里面的body,以及header使用驼峰。例如:http://127.0.0.1/v1/wechat/mch_info/list_mch_info?page=2&perPage=100
  • 用json格式返回
  • 使用Token令牌来做用户身份的校验与权限分级
  • 需要外部调用的部门内api 例如钉钉回调地址 必须走API网关

错误处理

不要直接将异常抛给客户端处理,一般需要一个统一的异常处理类,并且以统一格式将异常信息返回前端,统一格式参照目录“Response”

错误编码格式

https://open.weibo.com/wiki/Error_code 参照微博api 将api错误分级 code代码说明 200:解释 500 :解释 404:解释

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
{
    "code": 500,
    "msg": "Something bad happened",
}
本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2019.10.18 ,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
暂无评论
推荐阅读
编辑精选文章
换一批
RESTful规范Api最佳设计实践
RESTful是目前比较流行的接口路径设计规范,基于HTTP,一般使用JSON方式定义,通过不同HttpMethod来定义对应接口的资源动作,如:新增(POST)、删除(DELETE)、更新(PUT、PATCH)、查询(GET)等。
恒宇少年
2019/10/10
1K0
restful api接口规范和服务调用的区别_rest接口规范
网络应用程序,分为前端和后端两个部分。当前的发展趋势,就是前端设备层出不穷(手机、平板、桌面电脑、其他专用设备…)。因此,必须有一种统一的机制,方便不同的前端设备与后端进行通信。这导致API构架的流行,甚至出现”APIFirst”的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。
全栈程序员站长
2022/10/01
2K0
RESTful规范
什么是RESTful 一种软件架构风格、设计风格,而不是标准,只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁,更有层次,更易于实现缓存等机制。 一、URI规范 1.不用大写; 2.用中杠 - 不用下杠 _ ; 3.参数列表要encode; 4.URI中的名词表示资源集合,使用复数形式。 5.在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词(特殊情况可以使用动词),而且所用的名词往往与数据库的表格名对应
人生不如戏
2018/05/30
2.3K0
RESTful API设计指南
在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。一般来说,数据库中的表都是同种记录的”集合”(collection),所以API中的名词也应该使用复数。
lyb-geek
2018/07/26
5500
我们必须要知道的RESTful服务最佳实践
REST:Representational State Transfer(表象层状态转变),如果没听说过REST,你一定以为是rest这个单词,刚开始我也是这样认为的,后来发现是这三个单词的缩写,即使知道了这三个单词理解起来仍然非常晦涩难懂。如何理解RESTful架构,最好的办法就是深刻理解消化Representational State Transfer这三个单词到底意味着什么。
lyb-geek
2018/07/26
1.4K0
Restful 架构 API 接口经典设计误区
目前微服务架构盛行,在了解了很多的实际微服务项目中,发现很多同事在设计业务 API 接口时,写法五花八门,现总结下目前项目上设计业务 API 接口的一些比较经典误区写法。
猿芯
2021/05/27
8720
RESTful架构API风格与相关规范 极客开发者
以上是对RESTful架构的概述,在本文中,我将使用自己的理解完整的表述RESTful的规范,以及如何设计符合RESTful规范的API。实际上,在对计算机技术的理解中,一百个人可能会有一百种理解方式,尽管见仁见智,但我们的目的都是把技术当作工具,去实现我们的程序功能。如果在本文中的描述有所错误,或您有所不解,欢迎留言评论!
极客开发者
2022/01/18
4540
restful最佳实践--接口规范
前后端分离意味着,前后端之间使⽤ JSON 来交流,两个开发团队之间使⽤ API 作为契约进⾏交互。从此,后台选⽤的技术栈不影响前台。当我们决定需要前后端分离时,我们仍然还需要⾯对⼀系列的问题:
奋飛
2019/08/15
2.1K0
快速学习-RESTFul设计风格
REST(英文:Representational State Transfer,简称REST),表述性状态转移,指的是一组架构原则。
cwl_java
2020/03/27
1.4K0
前端要知道的RESTful API架构风格
前端程序员在开发完页面后总是要对接口的,跟后端联调有时候还占用蛮大的时间的,那么你了解你和后端对的接口都是什么风格吗,你们公司接口设计的如何,你使用愉快吗?自己在写Node服务时你遇到如何定义好接口的问题吗?下面介绍一种API架构风格,也是目前主流的API设计风格,你或许一直在使用。
张张
2019/12/27
1K0
【Restful】你还不懂Restful API规范吗?
进入正文之前,先带着小伙伴们了解几个名词,源自百度百科。 标题中涉及的核心名词API,restful
沁溪源
2021/08/13
1.6K0
yii2 restful 风格搭建(一)
最近在研究 yii2 如何搭建 restful api,将心得写下,欢迎一起讨论 使用yii2.0.13 advanced 版,将 frontend 整个作为 api 接口项目,除了接口的路由规则可以认证通过外,其他的路由规则都返回请求错误的格式
botkenni
2019/09/02
1.4K0
【RESTful】RESTful API 接口设计规范 | 示例
参考官方文档:https://tools.ietf.org/html/rfc2616
前端修罗场
2023/10/07
2.1K0
【RESTful】RESTful API 接口设计规范 | 示例
深入理解什么是RESTful API ?
越来越多的人开始意识到,网站即软件,而且是一种新型的软件。   这种"互联网软件"采用客户端/服务器模式,建立在分布式体系上,通过互联网通信,具有高延时(high latency)、高并发等特点。   网站开发,完全可以采用软件开发的模式。但是传统上,软件和网络是两个不同的领域,很少有交集;软件开发主要针对单机环境,网络则主要研究系统之间的通信。互联网的兴起,使得这两个领域开始融合,** 现在我们必须考虑,如何开发在互联网环境中使用的软件。**
AWeiLoveAndroid
2018/09/03
3.3K0
深入理解什么是RESTful API ?
无规矩不成方圆,聊一聊 Spring Boot 中 RESTful 接口设计规范
点击上方“芋道源码”,选择“设为星标” 管她前浪,还是后浪? 能浪的浪,才是好浪! 每天 10:33 更新文章,每天掉亿点点头发... 源码精品专栏 原创 | Java 2021 超神之路,很肝~ 中文详细注释的开源项目 RPC 框架 Dubbo 源码解析 网络应用框架 Netty 源码解析 消息中间件 RocketMQ 源码解析 数据库中间件 Sharding-JDBC 和 MyCAT 源码解析 作业调度中间件 Elastic-Job 源码解析 分布式事务中间件 TCC-Transaction
芋道源码
2022/06/20
4470
无规矩不成方圆,聊一聊 Spring Boot 中 RESTful 接口设计规范
RESTful API
网络应用程序,分为前端和后端两个部分。当前的发展趋势,就是前端设备层出不穷(手机、平板、桌面电脑、其他专用设备......)。
用户1214487
2022/03/26
1.8K0
RESTful API
restful api接口规范
RESTful API接口规范是设计Web服务的一种方法,它基于HTTP协议,并通过一系列约定来组织接口。以下是RESTful API接口规范的主要组成部分:
高老师
2024/12/24
3640
Webman实战教程:Exception异常插件如何解决开发中的异常问题
是程序在运行中出现不符合预期的情况及与正常流程不同的状况。一种不正常的情况,按照正常逻辑本不该出的错误,但仍然会出现的错误,这是属于逻辑和业务流程的错误,而不是编译或者语法上的错误。
Tinywan
2023/10/22
8100
Webman实战教程:Exception异常插件如何解决开发中的异常问题
RESTful API
RESTful架构是一种流行的互联网软件架构,它结构清晰,符合标准,易于理解,扩展方便。 REST是Representational State Transfer的缩写,翻译为“表现层状态转化”。表现层其实就是资源,因此可以理解为“资源状态转化”。 网络应用上的任何实体都可以看作是一种资源,通过一个URI(统一资源定位符)指向它。
王念博客
2019/07/25
1.1K0
Restful API 的设计规范
本文总结了 RESTful API 设计相关的一些原则,只覆盖了常见的场景。有些规则只是针对自己项目而言,并非其他做法都是错误的。 1. URI URI 表示资源,资源一般对应服务器端领域模型中的实体类。 URI规范 不用大写; 用中杠-而不用下杠_; 参数列表要encode; URI中的名词表示资源集合,使用复数形式; 资源集合与单个资源 资源集合: /zoos //所有动物园 /zoos/1/animals //id为1的动物园内的所有动物 单个资源: /zoos/1 //id为
Clearlove
2019/08/29
8140
Restful API 的设计规范
相关推荐
RESTful规范Api最佳设计实践
更多 >
交个朋友
加入腾讯云官网粉丝站
蹲全网底价单品 享第一手活动信息
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档