RESTful API接口设计标准及规范

最新推荐文章于 2022-01-04 23:06:06 发布
最新推荐文章于 2022-01-04 23:06:06 发布
阅读量1.2k 收藏 1
点赞数
分类专栏： 面试
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/DarkAngel1228/article/details/103549728
版权

URI规范

不用大写；
用中杠-不用下杠_；
参数列表要encode；
URI中的名词表示资源集合，使用复数形式。

方法

  • GET:查询
  • POST：创建单个资源
  • PUT:全量更新
  • PATCH/pætʃ/ ：部分更新
  • DELETE：删除
DarkAngel1228
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
RESTful API接口通用完整规范_V1.doc
06-19
REST它是一种使用URL来定位资源，使用HTTP请求描述操作的Web服务规范，本资源包含RESTful简介、设计原则、通用说明、规范细则、接口管理说明。
RESTful API介绍
D1842501760的博客
04-06 2405
文章目录RESTful API查看源图像什么是API?什么是RESTful API?解读REST(了解内容)RESTful API 规范信息过滤状态码（Status Codes）RESTful 的极致 HATEOAS-END- RESTful API 正式学习RESTful API之前,我们需要把什么是API搞懂. 什么是API? API（Application Programming Interface） 翻译过来是应用程序编程接口的意思。 相信大家对于API这个此已经不陌生了, 比如"我调用了某某的A
Java语言学习笔记-常用的API
qq_19627109的博客
01-26 161
常用的API 第一节：API概述 1.1 概述 **API:**应用程序编程接口。Java API是一本程序员的字典，是JDK中提供给我们使用的类的说明文档。这些类将底层的代码实现封装了起来，我们不需要关心这些类是如何实现的，只需要学习这些类如何使用即可。所以我们可以通过查阅API的方式，来学习Java提供的类，并得知如何使用它们 1.2 API使用步骤 1、打开帮助文档 2、点击显示，找到索引，看到输入框 3、你要找谁，就在输入框里输入，然后回车 4、看包，java.lang下的类不需要导包，其他需要 5
RESTFUL API
qq_21705851的博客
10-28 404
RESTful API 一、基本概念 RESTful API是一种约束、一种设计理念、一种架构风格，跟编程语言无关，跟平台无关，采用HTTP做传输协议 。 它使用URI定位资源，用HTTP动词（GET,POST,DELETE,DETC）描述操作 。其中URI为统一资源标识符，服务器上每一种资源，比如文档、图像、视频片段、程序都由一个通用资源标识符（Uniform Resource Identifi...
API 接口设计规范
Brook
07-16 421
API 接口设计规范 概述 这篇文章分享 API 接口设计规范，目的是提供给研发人员做参考。 规范是死的，人是活的，希望自己定的规范，不要被打脸。 路由命名规范 动作 前缀 备注 获取 get get{XXX} 获取 get get{XXX}List 新增 add add{XXX} 修改 update update{XXX} 保存 save save{XXX} 删除 delete delete{XXX} 上传 upload upload{XXX} 发送 send send{XXX} 请求方式 请求方式 描述
RESTful 接口规范
weixin_33743880的博客
08-14 96
原文地址：http://www.coderli.com/translate-restful-standard-resolved   OneCoder最近一直在使用Restful API，最近正好看到一篇自定义restful接口规范的“抛砖引玉”得的文章，索性翻译一下，与大家分享。 原文地址：http://java.dzone.com/articles/restful-standard-res...
RESTful 规范
梦否
08-29 4269
1. 基本概念     REST全称是Representational State Transfer，中文意思是表征性状态转移。指的是一组架构约束条件和原则。如果一个架构符合REST的约束条件和原则，我们就称它为RESTful架构。如果后台开发遵守了REST风格便可称为RESTful。 REST本身并没有创造新的技术，是一种软件架构风格，以更好地使用现有Web标准中的一些准则和约束。结构清晰、符合标准、易于理解、扩展方便。     RESTful架构是对MVC架构改进后所形成的一种架构，通过使用事先定义好的
restful规范
anmi3721的博客
09-07 427
一、restful介绍 1、web服务交互 　　网站提供的每个web服务都需要前后端交互，前后端交互的实现方案，通常叫作：web服务交互方案。 （1）目前主流的三种web服务交互方案 　　1）REST（Representational State Transgfer）表述性状态转移 　　REST是Roy Thomas Fielding博士于2000年在他的博士论文里提出来的。 ...
Restful接口规范
Be_insighted的博客
01-04 580
Restful接口规范 1、不推荐使用 rest 命名 url， 只能使用 get/post 方法。url 命名上规范如下：虽然 Rest 大法好，但是有时并不能一眼根据 url看出来是什么操作。 url 格式为： /api/v1/业务模块/子模块/动作 举例： GET /department/get/{id} 查询某个部门详细信息 POST /department/query 复杂查询 POST /department/add 添加部门 POST
基于 RESTful 架构的API设计原则和规范.docx
08-13
api 设计规范文档。基于RestFul。
RESTful API设计规范
03-15
RESTful API设计规范
RESTful-API-demo:RESTful API演示
05-02
使用express,MongoDb...设计规范（怎么用？） ####1. 网址中不能有动词，只能有名词，所用的名词往往与数据库的表格名对应。 ####2. 对于资源的具体操作类型，由HTTP动词表示。 * GET: 从服务器取回一个资源 * POST:
restful-api:restful-api规范以及对应加解密实现
04-30
api接口规范 一报文格式 content-type: application/json 二协议 如果有可能建议尽量用https。 三URL路径命名 1.域名 方式一： api.example.cn (推荐) 方式二： example.cn/api/ 2.版本控制 方式一：api.example....
Restful API思路
alashan007的博客
11-08 1335
1.通过服务器重写规则，将所有请求走一个入口方法，例如index.php的run()方法。 2.通过$_SERVER,找到请求方法，请求路径，请求参数，进行初始化参数 3.根据请求路径，走不同model处理，根据请求方法不同，走不同的处理方法。 4.补充，可以封装错误和异常处理，提前定义好允许的请求方法，等等。 以下为补充材料 https://blog.csdn.net/lmseo...
大厂对外提供的API接口入参命名规范
wiseyl的专栏
05-14 5811
我直截了当地说用驼峰式。为什么？ 我认为，像java语言或.net语言，实体类的属性一般是遵从驼峰式命名的（稍有不同的是java一般首字母小写，而.net是首字母大写）。我们的程序里的数据访问层一般均采用ORM框架。如果表字段是小写字母+下划线，那么，相应的POJO/POCO实体类的属性也会是小写字母+下划线，这样，违背了驼峰式命名规范，有违代码的整洁度。 接着，如我所期，云龙问“那你支付中心对外的api接口参数为什么用小写+下划线的方式呢？” 我答道，对外提供的接口， 如果用驼峰式。 首先，我...
restful api接口规范_RestFul的一些注意事项和接口开发规范
weixin_39670267的博客
11-29 363
一、 URIURI规范1.不用大写；2.用中杠 - 不用下杠 _ ；3.参数列表要encode；4.URI中的名词表示资源集合，使用复数形式。5.在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词（特殊情况可以使用动词），而且所用的名词往往与数据库的表格名对应。资源集合 vs单个资源URI表示资源的两种方式：资源集合、单个资源。资源集合：/zoo...
RESTful API 最佳实践（转载）
雾气
10-10 1304
转载： http://www.ruanyifeng.com/blog/2018/10/restful-api-best-practices.html RESTful 是目前最流行的 API 设计规范，用于 Web 数据接口的设计。 它的大原则容易把握，但是细节不容易做对。本文总结 RESTful 的设计细节，介绍如何设计出易于理解和使用的 API。 一、URL 设计 1.1 动词 + 宾...
RESTful设计方法
weixin_34235457的博客
08-13 399
REST REST，即Representational State Transfer的缩写。维基百科称其为“具象状态传输”，国内大部分人理解为“表现层状态转化”。 RESTful是一种开发理念。维基百科说：REST是设计风格而不是标准。 REST描述的是在网络中client和server的一种交互形式；REST本身不实用，实用的是如何设计 RESTful API（REST风格的网络接口）,一种...
restful api 接口设计规范
最新发布
11-30
RESTful API 是一种基于 HTTP 协议，通过 URI、HTTP 动词、HTTP 报文等方式来实现资源的增删改查等操作的一种 API 设计规范。其设计原则包括客户端-服务器、无状态、可缓存、统一接口等。具体来说，RESTful API 的设计应该遵循以下几个方面： 1. URI 设计：URI 应该清晰、简洁、易于理解，且应该使用名词而非动词来表示资源。 2. HTTP 动词：HTTP 动词应该与资源的操作相对应，例如 GET 方法用于获取资源，POST 方法用于创建资源等。 3. HTTP 报文：HTTP 报文应该包含足够的信息来描述资源的操作，例如请求头中的 Accept 字段用于指定客户端接受的数据类型，响应头中的 Content-Type 字段用于指定服务器返回的数据类型等。 4. 资源的表现形式：资源应该以多种不同的表现形式呈现，例如 JSON、XML 等。 5. 超媒体：超媒体是 RESTful API 的一个重要特性，它通过在响应中包含链接来描述资源之间的关系，从而使客户端能够自动发现和访问相关资源。 以下是一个示例： 假设我们要设计一个 RESTful API 来管理用户信息，我们可以按照以下方式设计 URI： - 获取所有用户信息：GET /users - 获取指定用户信息：GET /users/{id} - 创建用户信息：POST /users - 更新指定用户信息：PUT /users/{id} 删除指定用户信息：DELETE /users/{id} 其中，{id} 表示用户的唯一标识符。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值