美文网首页收藏
RESTful接口规范

RESTful接口规范

作者: 似朝朝我心 | 来源:发表于2022-05-12 17:05 被阅读0次

HTTP动词

资源的具体操作类型,由HTTP动词表示。

常见的五个HTTP动词(括号对应SQL命令)

  • GET (读取): 从服务器取出资源(一项或者多项)。
  • POST(创建): 在服务器新建一个资源。
  • PUT(完整更新): 在服务器更新一个资源(客户端提供改变后的完整资源)。
  • PATCH(部分更新): 在服务器更新一个资源(客户端提供改变的属性)。
  • DELETE(删除): 从服务器删除资源。

HTTP状态码

客户端每一次请求,服务区都必须给出回应。回应包括HTTP状态码和数据两部分。

HTTP状态码就是一个三位数,分成五个类别。

  • 1XX:相关信息
  • 2XX:操作成功
  • 3XX:重定向
  • 4XX:客户端错误
  • 5XX:服务器错误

常见状态码:(方括号中对应该状态码的HTTP动词)

  • 200 OK - [GET]:服务器成功返回用户请求的数据。
  • 201 CREATED - [POST、PUT、PATCH]:用户新建或修改数据成功。
  • 204 NO CONTENT - [DELETE]:用户删除数据成功。
  • 401 Unauthorized - [ * ]:表示用户没有权限(令牌、用户名、密码错误)。
  • 403 Forbidden - [ * ]:表示用户得到授权(与401错误相对),但是访问是被禁止的,比如管理员权限操作。
  • 404 NOT FOUND - [ * ]:用户发出的请求真的的是不存在的记录,服务器没有进行操作,也就是常见的404页面。
  • 500 INTERNAL SERVER ERROR - [ * ]:服务器内部错误.

相关文章

  • RESTFul API规范,看这篇就够了

    初尝RESTFul规范 RESTFul是一种HTTP API接口规范,只要满足的RESTFul规范,即可称为RES...

  • API接口定义规范

    API接口定义规范 编写时间:2020年02月06号 基本接口共识来源于RESTful接口规范,在这个接口规范的基...

  • Swagger规范 之 出错点

    Swagger规范是描述RESTful API的强大的定义格式。Swagger规范创建了一个RESTful接口,通...

  • RESTful 接口规范

    总方针 构建易于理解和使用的RESTful接口。 接口应该是直观的,调用者可以通过接口来获得系统或应用程序中所有业...

  • RESTful接口规范

    HTTP动词 资源的具体操作类型,由HTTP动词表示。 常见的五个HTTP动词(括号对应SQL命令) GET (读...

  • 【翻译】RAML1.0规范: RESTful API模型语言(1

    引言 本规范描述了RESTful API建模语言(RAML)。RAML是用于定义RESTful应用程序编程接口(A...

  • 2018年大四生产实习接口文档

    六. 后端接口文档 6.1 接口文档说明 由于该项目为前后端分离项目且接口符合 RESTful API 规范,项目...

  • OpenAPI 规范摘要

    介绍 OpenAPI 规范(OAS)定义了一个标准的、语言无关的 RESTful API 接口规范,它可以同时允许...

  • RestfulAPI规范

    Restful是目前最流行的API设计规范,用于Web数据接口的设计。 动词+宾语Restful的核心思想就是,客...

  • 前端接口规范

    restful接口规范:就是为了采用不同的后台语言,也能使用同样的接口获取到同样的数据 1、接口详情: 接口url...

网友评论

    本文标题:RESTful接口规范

    本文链接:https://www.haomeiwen.com/subject/psfeurtx.html