Restful风格API规范Restfun API协议域名版本路径HTTP动词过滤信息(Filtering)状态(Status Codes)错误处理(Error handling)返回结果 Restfun APIREST(Representational State Transfer)全称是表属性状态转移,其实指的就是资源的表述。如果一个架构符合REST原则,就称为Restful架构。解决问题
网络应用程序,分为前端和后端两个部分。当前的发展趋势,就是前端设备层出不穷(手机、平板、桌面电脑、其他专用设备......)。因此,必须有一种统一的机制,方便不同的前端设备与后端进行通信。这导致API构架的流行,甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。我以前写过一篇《理解RESTful架构》,探讨如何理解这个概念。今天,我
GET(SELECT):从服务器取出资源(一项或多项)。 POST(CREATE):在服务器新建一个资源。 PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。 PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性)。 DELETE(DELETE):从服务器删除资源 ...
转载 2021-07-20 13:48:00
388阅读
2评论
关于 RESTful API 中 HTTP 状态的定义其中 2XX/3XX 其实都是请求成功,但是结果不同。4XX 是请求出错
转载 2023-05-08 14:20:07
118阅读
RestFull风格概念RESTFUL是一种网络应用程序的设计风格和开发方式,基于HTTP,可以使用XML格式定义或JSON格式定义。RESTFUL适用于移动互联网厂商作为业务使能接口的场景,实现第三方OTT调用移动网络资源的功能,动作类型为新增、变更、删除所调用资源。其实就是一种非常优雅的规范.简单理解,使用名词而非使用动词,并根据请求的方式不同来得到响应的响应. 例如 分别实现用户的
转载 2024-05-08 21:52:51
131阅读
*Note: 本篇所有请求内容类型(Content-Type)均为 application/json 本篇所有实现基于Spring框架0. 参考资料Kemikit.RESTful API Design: How to handle errors?筑网.企业实战之spring项目《接口响应体格式统一封装》菜鸟教程.RESTful 架构详解正篇开始, 关于 RESTful API 的响应(Respo
1.1 消息1xx(Informational 1xx) 该类状态代码用于表示临时回应。临时回应由状态行(Status-Line)及可选标题组成, 由空行终止。HTTP/1.0中没有定义任何1xx的状态代码,所以它们不是对HTTP/1.0请求的   合法回应。实际上,它们主要用于实验用途,这已经超出本文档的范围。 1.2 成功2xx(Successful 2xx) 表示客户端请求被成功接收、理解、
Response对象 功能:设置响应消息,可以通过查看API 输入ServletResponse一、设置响应消息。 1.设置相应行。 01.格式:HTTP/1.1 200 ok 02.设置状态: setSatatus(int sc) 2.设置响应头:setHeader(String name,String value) 3.设置响应体。字节输出流为任意数据 字符输出流:PrintWriter g
1、405 Method Not Allowed请求方式错误,比如服务端约定PUT请求,结果客户端采用了GET;我的项目中是这样的,访问的服务真实存在,但是用PUT,POST访问的url是不存在的,所以出现这样的问题,就是访问的IP写成了别人的了。 2、415 Unsupported Media Type请求的Content-Type 错误,对于GET请求没有限制,但是对于其他请
转载 2024-08-19 14:18:12
37阅读
常用• 2xx 操作成功o 200 正常的成功返回o 201 服务器资源已经存在,直接返回o 202 请求已提交,正在异步处理• 3xx 地址重定向,接口或地址已经被移走• 4xx 客户端请求错误o 400 客户端通用请求出错o 401 未登录或会话过期(需要登录但未登录或会话过期)o 403 没有权限访问、操作(IP受限或已登录但没权限)o 404 接...
原创 2022-12-02 11:31:40
327阅读
restful apirest 全拼是resource representational state transfer,资源表现层状态转移,在网络中的进行交互的数据都是一个个资源,rest便是对这其中数据状态转移过程的规范,是一种web应用接口的规范。rest规范每一个URI都是一个资源,因为我们在请求一个接口的时候,其实就是访问服务器对应URI地址下的资源,所以说每一个URI都是一个资源。同一种
转载 2024-05-22 10:51:39
48阅读
HTTP状态HTTP状态会告诉API的消费者以下事情: 请求是否执行成功了 如果请求失败了,那么谁为它负责  HTTP的状态有很多,但是WebAPI不一定需要支持所有的状态。HTTP状态一共分为5个级别: 1xx,属于信息性的状态。Web。 2xx,意味着请求执行的很成功。 200 - Ok,表示请求成功;&nbsp
转载 2024-01-03 18:57:46
128阅读
API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。   API一般都是基于http、https协议的。也就是说接口一般都是基于这两种协议(硬件之间也有对应的协议,再次就不作深究)  常用的方法是Get和Post,
转载 2023-10-09 20:03:20
149阅读
文章参考RESTful API 设计指南——阮一峰概念一种软件架构风格、设计风格,而不是标准,只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁,更有层次,更易于实现缓存等机制。演进一、协议API与用户的通信协议,总是使用HTTPs协议。二、域名应该尽量将API部署在专用域名之下。https://api.example.com如果确定API很简
一、 Django REST framework介绍Django REST framework是基于Django实现的一个RESTful风格API框架,能够帮助我们快速开发RESTful风格的API。官网:https://www.django-rest-framework.org/中文文档:https://q1mi.github.io/Django-REST-framework-docu
转载 2024-02-16 20:03:32
61阅读
网络应用程序,分为前端和后端两个部分。当前的发展趋势,就是前端设备层出不穷(手机、平板、桌面电脑、其他专用设备......)。因此,必须有一种统一的机制,方便不同的前端设备与后端进行通信。这导致API构架的流行,甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。我以前写过一篇《理解RESTful架构》,探讨如何理解这个概念。
转载 2024-05-22 12:05:03
76阅读
文章目录基础api设计基本思路举例:(axios)新增一个title为“abc”的item删除id为5的item把id为5的item的title修改为"bbb"把id为5的item修改{title:"bbb",content:"xxx"}获取id小于10000中前100个item(字段需要自己设置)登录、登出,注册,注销HTTP报头(暂略)HTTP状态(部分) 基础1.最好要带有版本(设置在u
转载 2024-03-15 15:26:13
79阅读
接口: API(Application Programming Interface,应用程序接口)是一些预先定义的接口(如函数、HTTP接口),或指软件系统不同组成部分衔接的约定。 用来提供应用程序与开发人员基于某软件或硬件得以访问的一组例程,而又无需访问源码,或理解内部工作机制的细节。接口(API): 可以指访问servlet, controller的url, 调用其他程序的 函数架构风格: a
转载 2024-04-30 19:03:16
44阅读
前言  对于前后端分离的项目,主要是以API为界限进行解耦,那么在web开发中,对于api的设计能够遵循REST设计原则,即可以称为Restful api。使用Restful设计api主要有两点好处,一是表现力更强,更易于理解;二是Restful为无状态的,不管前端是何种设备何种状态都能够无差别的请求资源。构建步骤一:基于业务领域的数据建模,而不是基于功能建模 基于功能建模时,会造成api臃肿并且
转载 2024-03-18 22:14:03
67阅读
WebAPI在过去几年里非常的盛行,我们很多以往的技术手段都慢慢的转换为使用WebAPI来开发,因为它的语法简单规范化,以及轻量级等特点,这种方式收到了广泛的推崇。 通常我们使用RESTFul(Representational State Transfer)的设计方式来设计Web api,这通常用来分离API结构了业务逻辑,它使用典型的HTTP方法,诸如GET,POST.DELETE,PUT来和
转载 2024-04-09 09:21:29
103阅读
  • 1
  • 2
  • 3
  • 4
  • 5