RESTful 是目前最流行的 API 设计规范，用于 Web 数据接口的设计。它的大原则容易把握，但是细节不容易做对。本文总结 RESTful 的设计细节，介绍如何设计出易于理解和使用的 API。一、URL 设计1.1 动词 + 宾语RESTful 的核心思想就是，客户端发出的数据操作指令都是"动词 + 宾语"的结构。比如，GET /articles这个命令，GET是动词，/artic
转载
2024-05-22 10:49:36
884阅读
这里整理的REST API的设计规范，注意和后端开发的API接口文档做一下区分，不是一个概念。API是REST API的超集，REST API 是API的子集；所有的REST API都是API，但不是所有的API都是REST API一、公共要求API通常使用HTTPs协议，确保交互数据的传输安全，域名尽量将api部署在专用域名下https：//api.example.com，具体公共要求如下1.在
转载
2023-07-31 16:35:29
190阅读
什么是restful?REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”REST从资源的角度类审视整个网络，它将分布在网络中某个节点的资源通过URL进行标识，客户端应用通过URL来过去资源的表征，获得这些表征致使这些应用转变状态所有的数据，不管是通过网络获取的还是操作数据库获得(增删改查) 的数据
转载
2023-05-30 09:30:57
157阅读
一 什么是Restful?随着互联网的发展，前端设备层出不穷(手机、平板、桌面电脑、其他专用设备......)，这些(客户端)设备都需要访问后端进行通信，因此，必须有一种统一的机制，方便不同的前端设备与后端进行通信,于是RESTful诞生了，它可以通过一套统一的接口为 Web，iOS和Android提供服务二 Restful 设计规范1.协议API与用户的通信协议，总是使用https协
转载
2024-04-01 20:50:25
76阅读
WCF Web API 是 “First-class programming model for HTTP in WCF”，而 HTTP 是 Web 世界的通行证，Web API 可以让我们更轻松地畅游于 Web 编程世界。实现 REST 只是 WCF Web API 小试牛刀，我们还可以不用候改任何服务端代码，只改变客户端请求的方式，就可以返回不现类型的数据。
网络应用程序，分为前端和后端两个部分。当前的发展趋势，就是前端设备层出不穷（手机、平板、桌面电脑、其他专用设备......）。因此，必须有一种统一的机制，方便不同的前端设备与后端进行通信。这导致API构架的流行，甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。我以前写过一篇《理解RESTful架构》，探讨如何理解这个概念。今天，我
转载
2024-03-11 22:00:45
33阅读
REST（Representational State Transfer）即表述性状态传递，REST指的是一组架构约束条件和原则。它是一种针对网络应用的设计和开发方式，可以降低开发的复杂性，提高系统的可伸缩性。REST就是选择通过使用 http 协议和 uri，利用 client/ server model 对资源进行 CRUD (Create/Read/Update/Delete)增删改查操作。
转载
2024-02-26 19:55:02
119阅读
一、REST APIREST、RESTful、REST APIAPI： 是应用程序编程接口，是预先定义好的函数，可以供应用程序或开发人员访问调用
REST（Representational State Transfer，表述化状态转移）：指的是一组架构约束条件和原则。
RESTful：满足REST约束条件和原则的设计规范或者架构风格
REST API：是北向接口的主流设计方式，遵循RESTful设
转载
2024-03-28 20:46:08
510阅读
在Kubernetes（K8S）中，REST API是一种常见的用于访问和操作集群资源的方式。REST API接口规范定义了API的端点、请求方法、请求参数等内容，遵循这些规范可以更好地构建和管理K8S集群。
接下来，我将为你详细介绍如何实现REST API接口规范，让你对这个过程有更清晰的认识。
首先，我们来总结一下实现REST API接口规范的基本流程：
| 步骤 | 操作
原创
2024-05-06 11:30:16
178阅读
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已在软件、Web和移动应用程序开发领域无处不在，从企业内部到面向公众的应用以及与合作伙伴进行系统集成。通过使用API，开发人员可以创建满足各种客户需求的应用程序。而软件架构也在随着应用程序开发方法的改变而改变。由于API在软件开发过程中如此关键，那么对API的管理就显得格外重要。通过API管理工具和平台能够大大简化API管理的难度和复杂度。下面列举了一些顶级API管理工具
转载
2024-07-19 16:44:14
1051阅读
你知道吗，在 Jmix 中，REST API 有两种实现方式！很多应用是采取前后端分离的方式进行开发。这种模式下，对前端的选择相对灵活，可以根据团队的擅长技能选择流行的 Angular/React/Vue 之一，或者前端为App/小程序等手机应用。Jmix 的一种典型应用场景就是作为这种类型应用程序的高级别管理 UI 和后端。为此，Jmix 提供了强大的通用 REST API 功能，支持包括开箱即
# Docker Server REST API URL
Docker is an open-source platform that allows developers to automate the deployment and management of applications using containers. Docker provides a RESTful API that en
原创
2023-08-25 15:01:42
114阅读
最近更新： 1.网易的dao类方法作为url看起来真亲切啊！getPositionByIdhttp://hr.163.com/getPositionById.do?rms=1&id=6782.http://hr.163.com/queryPosition.do?rms=1 这个倒是稍微好一点。针对上面两个，参考RESTful的url设计。 我
数据云URL过滤技术
摘要：随着互联网技术的不断发展和Web 2.0 技术的广泛推广使用，社交网络、Blog、Wiki、Twitter、Webmail、免费空间等的出现，不仅给人们带来了生活方式、生产方式上很多的便捷与好处，也促使着URL过滤技术的进化。URL过滤不仅有利于保障企业的生产效率，防止网络沉迷与滥用，而且是网络安全架构的一个重要组成部分。 【51CTO.com 综合消息】当今
转载
2024-04-28 12:17:56
21阅读
一直想比较一下这两种风格，却不知如何落笔，最终写成了如下的FAQ形式。什么是SOAP？简单对象访问协议，基于XML，是一种应用协议，可以跨多种传输协议来传递消息（比如HTTP、SMTP），Soap是针对RPC的解决方案。 Soap的初衷是作为一种轻量级解决方案出现的，采用xml格式定义过程调用和返回，一个Soap消息就是一个特定格式和内容的XML文档。什么是Restful web se
1. RESTful 规范概念REST 有一系列规范，满足这些规范的 API 均可称为 RESTful API。REST 规范把所有内容都视为资源，也就是说网络上一切皆资源。REST 架构对资源的操作包括获取、创建、修改和删除，这些操作正好对应 HTTP 协议提供的 GET、POST、PUT 和 DELETE 方法。HTTP 动词与 REST 风格 CRUD 的对应关系见下表：REST 具有以下核
转载
2024-03-20 17:36:20
69阅读
前后端接口规范 - RESTful 版本规范的三个目标：简洁、统一、开放。关于如何设计良好风格的 RESTful API，Github 有一份满分答案，熟读三遍，其义自现。本规范将在其基础之上使用尽可能简单的表述方式从以下几个常见部分作出详细约定：基础约定创建类接口查询类接口文件类接口敏感类接口图表类接口注意本规范是笔者在所在公司内部制定的规范整理而来的接口规范模板，仅供你在制定规范时候参考，在落
转载
2024-01-04 12:18:03
121阅读
一、什么是restful REST：（Representational State Transfer）中文：“表现层状态转移”，它是一种软件的架构风格、设计风格，提供了一组设计原则和约束条件，可以简单的理解成为一种规范。 RESTful：满足REST架构约束条件和原则的应用程序或设计就是 RESTful。二、RESTful API接口规范 1、API（接口）与用户的通信协议，总是使用HTTP
转载
2023-10-12 18:17:13
89阅读
