RESTFul规范RESTFul是一种HTTP API接口规范，只要满足的RESTFul规范，即可称为RESTFul API。既然是接口，我们先来了解一下，他和传统的API接口有何不同吧。本文以尽量简单明了的文字来介绍、描述，只讲核心内容，仅供入门指引。1 与传统API的区别RESTFul世界中，一切皆抽象为资源(Resource)。用户是资源，文章是资源、评论是资源，抽象一点的session、t
转载
2024-05-22 12:04:25
96阅读
1. 协议
API 和用户的交流协议，必须使用HTTPs。
2. 范围
API 应当部署在专用范围名称下。
3. 版本
URL地址里面应当包括API 版本号。
正确示例
v1, v2, v3
错误示例
v-1, 1.2
4. 端点
端点是API的特殊URL，在Restful架构范围内，每个URL代表一个资源，因此URL里面没有动词，只
转载
2024-05-27 18:12:46
174阅读
网络应用程序，分为前端和后端两个部分。当前的发展趋势，就是前端设备层出不穷（手机、平板、桌面电脑、其他专用设备......）。因此，必须有一种统一的机制，方便不同的前端设备与后端进行通信。这导致API构架的流行，甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。我以前写过一篇《理解RESTful架构》，探讨如何理解这个概念。今天，我
转载
2024-03-11 22:00:45
33阅读
REST（Representational State Transfer）是一种基于 协议的 Web 架构风格，它的出现简化了 Web 应用的开发和维护工作，成为现代 Web 开发的基础。RESTful API 设计规范是 Web 应用开发的重要一环，本文将从特点与技术现状、设计规范、应用场景和发展趋势四个方面进行介绍。正文开始前我们可以先了解下：REST API 简介 - REST
原创
2023-04-13 16:20:00
221阅读
目录文章目录目录API 设计规范Design-First（设计优先）Code-First（编码优先）API 设计规范通常，设计 API 规范有两个方向，Design-First（设计优先） 或 Code-First（编码优先）。Design-First（设计优先）即优先设计 API 规范，
原创
2021-07-14 15:31:59
838阅读
RESTful 是目前最流行的 API 设计规范，用于 Web 数据接口的设计。降低开发的复杂性，提高系统的可伸缩性。 Restful API接口规范包括以下部分： 一、协议 API与用户的通信协议，使用HTTPs协议或者HTTP协议，统一确定用一种。 二、域名 应该尽量将API部署在专用域名之下，如https://api.XXXXXX.com；如果多个项目创建API，把项目名称带上 如https
转载
2024-04-30 12:49:41
162阅读
一：REST API的设计 （一）HTTP动词 （二）资源的原型 文档(Document)： 集合(Collection)： 仓库(Store)： 控制器(Controller)： （三）RESTful设计中URI命名的规范 资源命名规范： URI命名规范： URI格式规范： 举例： URI的que
转载
2019-10-11 23:16:00
268阅读
2评论
概述 这篇文章分享 API 接口设计规范，目的是提供给研发人员做参考。 规范是死的，人是活的，希望自己定的规范
转载
2020-09-25 15:32:00
255阅读
2评论
目录
文章目录
目录
REST
RESTful API
RESTful API 设计规范
URI
Request
Response
登录认证问题
动作类型的资源定义
HATEOAS
REST
早古时期，软件和网络是两个不同的领域，前者围绕着单机环境展开，而后者则研究系统之间的通信。随着互联网的兴起，使得这两个领域开始融合，首当其冲的就是基于 HTTP 协议的 Web 服务，越来越
原创
2021-07-22 15:43:56
1222阅读
RESTful 是目前最流行的 API 设计规范，用于 Web 数据接口的设计。 它的大原则容易把握，但是细节不容易做对。本文总结 RESTful 的设计细节，介绍如何设计出易于理解和使用的 API。 一 URL设计 动词+宾语 RESTful的核心思想就是，客户端发出的数据+操作指令都是“动词+宾
转载
2020-10-19 10:25:00
55阅读
2评论
优秀的设计是产品变得卓越的原因。设计API意味着提供有效的接口，可以帮助API使用者更好地了解、使用和集成，同时帮助人们有效地维护它。每个产品都需要使用手册，API也不例外。
推荐
原创
2021-07-05 10:15:30
4316阅读
点赞
接口（API）设计规范一、接口（API）设计规范1.1 基本规范1.1.1 公共参数1.1.2 响应数据1.1.3 字段类型规范1.1.4 上传/下载1.1.5 避免精度丢失
原创
2021-07-09 10:57:43
2881阅读
转载：https://www.cnblogs.com/mayite/p/9798913.html RESTful 是目前最流行的 API 设计规范，用于 Web 数据接口的设计。 它的大原则容易把握，但是细节不容易做对。本文总结 RESTful 的设计细节，介绍如何设计出易于理解和使用的 API。
转载
2022-05-30 17:57:01
143阅读
概述这篇文章分享 API 接口设计规范，目的是提供给研发人员做参考。规范是死的，人是活的，希望自己定的规范，不要被打脸。路由命名规范动作前缀备注获取getget{XXX}获取getget{XXX}List新增addadd{XXX}修改updateupdate{XXX}保存savesave{XXX}删除deletedelete{XXX}上传uploadupload{XXX}发送sendsend{XX
原创
2021-04-27 16:37:28
1604阅读
本文是为 腾讯大渝网 API开发规范拟定的一个beta版，文章大量参考了目前比较常见的RESETful API设计。为了更好的讨论规范带来的争议及问题，现已把该文档整理并开源到 github。关于「能愿动词」的使用为了避免歧义，文档大量使用了「能愿动词」，对应的解释如下： 必须 (MUST)：绝对，严格遵循，请照做，无条件遵守； 一
转载
2022-12-27 18:12:32
159阅读
工作中如果要设计API，那么你的接口符合RESTful API规范吗？什么是RESTful？那我们通过本篇文章一起来学习下吧！
原创
2022-01-16 18:04:54
172阅读
说明：在实际的业务中，难免会跟第三方系统进行数据的交互与传递，那么如何保证数据在传输过程中的安全呢（防窃取）？除了https的协议之外，能不能加上通用的一套算法以及规范来保证传输的安全性呢？下面我们就来讨论下常用的一些API设计的安全方法，可能不一定是最好的，有更牛逼的实现方式，但是这篇是我自己的经验分享.一、token 简介Token：访问令牌access token, 用于接口中, 用于标识接
原创
2023-07-28 14:31:06
117阅读
