当前位置：首页 > news >正文

常见的 API 设计风格

news 来源：原创 2025/8/26 13:52:01

在软件开发中，常见的 API 设计风格主要有以下几种，每种风格适用于不同的场景和需求：

1. RESTful API (主流)

特点：

基于 HTTP 协议，使用标准方法（GET/POST/PUT/DELETE）
资源导向（URI 表示资源，如 /users）
无状态、可缓存、统一接口
通常返回 JSON/XML

适用场景：

公开的 Web 服务（如 GitHub API）
前后端分离架构
需要简单、易理解的接口

示例：

GET /api/users/123

2. RPC（Remote Procedure Call）

特点：

强调"动作"而非资源（如 /deleteUser）
通常使用 POST 方法（所有操作通过 POST 发送）
协议无关（可通过 HTTP、TCP 等实现）

变种：

JSON-RPC：轻量级，基于 JSON
gRPC：Google 开发的高性能二进制协议（基于 HTTP/2）
XML-RPC：传统 SOAP 的前身

适用场景：

内部微服务通信（如 gRPC）
需要高性能的场景
操作导向的系统（如银行转账）

示例：

POST /rpc
{"method": "deleteUser","params": {"id": 123},"id": 1
}

3. GraphQL (新兴)

特点：

客户端自定义查询字段
单一端点（通常 /graphql）
强类型系统
减少过度获取（Over-fetching）数据

适用场景：

复杂数据关系的系统（如社交网络）
需要灵活查询的客户端（如移动端）
多数据源聚合

示例：

query {user(id: 123) {nameposts(limit: 5) {title}}
}

4. SOAP (传统)

特点：

基于 XML 的协议
严格的 WSDL 规范
内置安全/事务支持
通常通过 HTTP POST 传输

适用场景：

企业级系统（如银行、政府）
需要 ACID 事务的场景
遗留系统集成

示例：

POST /soap
<Envelope><Body><GetUser><Id>123</Id></GetUser></Body>
</Envelope>

5. WebSocket API

特点：

全双工实时通信
保持长连接
适合高频数据推送

适用场景：

实时聊天应用
股票行情推送
在线游戏

示例：

// 客户端代码
socket.send(JSON.stringify({action: "join", room: "news"}));

6. Webhook

特点：

反向 API（服务端主动调用客户端）
事件驱动模型
通常用于异步通知

适用场景：

支付结果回调
CI/CD 流水线触发
第三方服务集成（如 Slack 机器人）

示例：

POST /callback
Content-Type: application/json
{"event": "payment_success","order_id": "12345"
}

风格对比表

风格	协议	数据格式	性能	灵活性	学习成本	典型应用
RESTful	HTTP	JSON/XML	中	中	低	公开 Web API
RPC/gRPC	任意	二进制	高	低	中	微服务内部通信
GraphQL	HTTP	JSON	可变	高	高	复杂数据查询
SOAP	HTTP/SMTP	XML	低	低	高	企业级系统
WebSocket	WS/WSS	任意	高	中	中	实时应用
Webhook	HTTP	JSON/XML	-	高	低	事件通知

如何选择 API 风格？

公开 API → RESTful 或 GraphQL
内部高性能通信 → gRPC
实时双向通信 → WebSocket
企业级集成 → SOAP（仅限遗留系统）
事件驱动架构 → Webhook + RESTful

现代系统常组合使用多种风格，例如：

用 RESTful 提供基础 CRUD
用 GraphQL 处理复杂查询
用 gRPC 处理微服务间通信
用 Webhook 实现异步通知

常见的 API 设计风格

在软件开发中，常见的 API 设计风格主要有以下几种，每种风格适用于不同的场景和需求： 1. RESTful API (主流) 特点： 基于 HTTP 协议，使用标准方法（GET/POST/PUT/DELETE）资源导向（UR…...

编程日记 2025/8/26 13:52:01

Grass.io项目现状：DePIN亮眼明星，扩张中的AI数据银行

Grass.io项目现状：DePIN亮眼明星，扩张中的AI数据银行 Grass如何在DePIN项目丛林中脱颖而出？答案在于其"零门槛"策略——用户是基石，其他一切皆为杠杆。 Grass通过"技术+模式"双轮驱动打破行业内卷：零知识证明技术与Solana Layer2架构确保数据真实…...

编程日记 2025/8/20 21:15:09

ERR_PNPM_DLX_NO_BIN No binaries found in tailwindcss

场景复现： 最近在vue3项目中安装了tailwindcss，但是它默认帮我安装的版本是4XX的，导致我执行 npx tailwindcss init -p报错了。解决方案： 更改tailwindcss的版本为3 pnpm add -D tailwindcss3再次执行生成tailwindcss的初始…...

编程日记 2025/8/20 7:23:06

2025“钉耙编程”中国大学生算法设计春季联赛（6）（1001，1003，1008）：1007

不知道为啥，感觉后面的联赛题目有挺多出的是模拟题目（这三道题目难度依次递增） 1001 #include<bits/stdc.h> using namespace std; #define int long long const int op1e97; const int o1e34;inline void solve(){int n,a,b,c;cin>…...

编程日记 2025/8/22 4:43:30

Leetcode 2814. 避免淹死并到达目的地的最短时间

1.题目基本信息 1.1.题目描述现给定一个 n * m 的索引从 0 开始的二维字符串网格 land，目前你站在为 “S” 的单元格上，你需要到达为 “D” 的单元格。在这片区域上还有另外三种类型的单元格： “.”：这些单元格是空的。 “X”…...

编程日记 2025/8/20 23:47:35

4.15【A】pc homework3~

5 假设read_document函数可以实现读取第m个文件，并返回该文本文档的每行数据那么考虑双层并行结构，外层为文档级并行，内层为每个文档内的行级并行动态分配文档任务，避免线程闲置 #include <omp.h> int total_words …...

编程日记 2025/8/21 4:16:51

aslist和list的区别

‌Arrays.asList和List的主要区别在于它们的固定长度和不可变性、与原始数组的关系、性能以及使用场景。一、固定长度和不可变性 ‌Arrays.asList‌：通过Arrays.asList方法创建的List是一个固定长度的List，其长度与原始数组相同。这意味着你不能通过添…...

编程日记 2025/8/20 19:24:26

Notepad++中将文档格式从Windows（CR LF）转换为Unix（LF）

在Windows中用记事本写了一个.sh的Linux运行脚本，是无法直接在Linux中执行，需要首先把文本编码格式转换为Unix的，特别是换行符这些，转换步骤如下： 1、打开文档在Notepad中打开需要转换的文件。 2、进入文档格式转换…...

编程日记 2025/8/17 8:55:41

控制理论与应用Latex模版/中文Latex

报错1 ! Package CJK Error: Invalid character code. 解决方法： 用记事本打开tex文件另存为，选择utf-8格式 ! paragraph ended before \mulearg was complete. 备注，控制理论与应用有个自己的模版内容，是通过导入方式调用…...

编程日记 2025/8/25 9:35:01

Linux指令和权限(10-3)

部分指令和权限一丶指令 1.echo echo的基础作用向显示器输出。作用类似于C语言的printf，C的cout。 1.1 echo 输入内容 – 会显示输出到屏幕的下一行 echo "hello Linux"1.2 echo 输入内容>目标文件 – 向目标文件输出内容（输出重定向&…...

编程日记 2025/8/20 20:46:36

算法堆排序记录

【算法】排序算法之堆排序 - 知乎应用场景：获取第n个大或者小的数操作步骤： 1、将数组构造成堆 2、调整根节点为最大堆 ->倒序对每个根节点执行最大化 ->根节点最大化过程中如果发生交换，需要保证子节点也为最大堆（执行…...

编程日记 2025/8/25 15:02:44

2025年第十六届蓝桥杯省赛JavaB组真题回顾

第16届蓝桥杯省赛已经结束了，第一次参加也是坐牢了4个小时，现在还是来总结一下吧（先声明以下的解法，大家可以当作一种思路来看，解法不一定是正解，只是给大家提供一种能够正常想到的思路吧） 试题…...

编程日记 2025/8/20 18:21:21

qt 事件及事件过滤

在 Qt 中，事件是对象与用户或系统交互的基本方式。Qt 通过事件机制使得控件和其他对象可以响应用户的操作（如鼠标点击、键盘输入等），以及其他系统级事件（如窗口大小变化、定时器事件等）。 Qt 事件处理机制…...

编程日记 2025/8/24 9:13:42

RPCRT4!OsfCreateRpcAddress函数分析之AssociationBucketMutexMemory数组的填充

第一部分： 1: kd> p RPCRT4!OsfCreateRpcAddress0x28: 001b:77c0f4f5 e888e5ffff call RPCRT4!OSF_ADDRESS::OSF_ADDRESS (77c0da82) 1: kd> t RPCRT4!OSF_ADDRESS::OSF_ADDRESS: 001b:77c0da82 ?? ??? 1: kd> kc # 00 RPCRT4!…...

编程日记 2025/8/25 1:16:32

lvs + keepalived + dns 高可用

项目题目实验步骤： 1.规划各自IP地址： 以lb-backup为例,修改ip地址即可 [rootlb-backup ~]# nmcli connection modify ens160 ipv4.addresses 192.168.72.106/24 ipv4.dns 223.5.5.5 ipv4.gateway 192.168.72.2 ipv4.method manual connection.autoc…...

编程日记 2025/8/23 12:19:37

多模态医学AI框架Pathomic Fusion，整合了组织病理学与基因组的特征

小罗碎碎念在医学AI领域，癌症的精准诊断与预后预测一直是关键研究方向。这篇文章提出了Pathomic Fusion这一创新框架，致力于解决现有方法的局限。传统上，癌症诊断依赖组织学与基因组数据，但组织学分析主观易变，基因…...

编程日记 2025/8/23 10:20:21

安卓基础（SQLite）

基础 import sqlite3# 连接到数据库 conn sqlite3.connect(mydatabase.db) cursor conn.cursor()# 执行查询 cursor.execute("SELECT * FROM users") rows cursor.fetchall()for row in rows:print(row)# 关闭连接 conn.close() 创建一个继承自 SQLiteOpenHelpe…...

编程日记 2025/8/22 17:51:00

代码提错分支处理方法

如果你不小心将代码提交到了测试分支，并且希望将这些更改应用到正式分支，同时又不想引入测试分支上的其他未准备好合并的代码，可以按照以下步骤操作： 查看提交记录：首先确认你在测试分支上所做的具体提交。切换到正式…...

编程日记 2025/8/19 8:30:54

OpenGL学习笔记（几何着色器、实例化、抗锯齿）

目录几何着色器爆破物体法向量可视化实例化（偏移量存在uniform中）实例化数组（偏移量存在顶点属性中）小行星带抗锯齿SSAA（Super Sample Anti-aliasing）MSAA（Multi-Sampling Anti-aliasing&…...

编程日记 2025/8/17 20:44:13

Git 学习笔记

这篇笔记记录了我在git学习中常常用到的指令，方便在未来进行查阅。此篇文章也会根据笔者的学习进度持续更新。网站分享 Git 常用命令大全 Learn Git Branching 基础 $ git init //在当前位置配置一个git版本库 $ git add <file> //将文件添加至…...

编程日记 2025/8/23 23:03:58

浅析停车管理系统接入AI的提升

随着人工智能技术的快速发展，传统停车管理系统正在经历智能化变革。AI技术的引入不仅解决了停车管理中的诸多痛点，更为智慧城市建设提供了重要支撑。本文将从效率提升、体验优化、管理升级三个方面，详细分析AI技术为停车管理系统带来的显著提…...

编程日记 2025/8/25 19:44:11

PCL八叉树聚类

PCL八叉树聚类主要流程完整代码部分代码解析关键元素解析std::for_each算法Lambda表达式等价效果主要流程读取点云数据：从PCD文件中加载原始点云构建八叉树：对点云进行八叉树空间划分获取体素中心：提取八叉树中所有被占据的体素中…...

编程日记 2025/8/20 18:20:13

微服务最佳实践：全链路可用性保障体系

微服务最佳实践：全链路可用性保障体系一、流量管控：分级限流与负载均衡（一）动态限流策略单机限流：采用令牌桶（允许突发流量，固定速率生成令牌）或漏桶算法（流量整形，固定速率处理请求），如Go的time/rate、Uber的ratelimit库，控制单节点流量峰值。分布式限流：通…...

编程日记 2025/8/25 14:16:52

智慧声防：构筑海滨浴场安全屏障的应急广播系

海滨浴场是夏季旅游的热门目的地，但潮汐变化、离岸流、突发天气、溺水事故等安全隐患时刻威胁着游客安全。传统的安全管理依赖人工瞭望和喊话，存在覆盖范围有限、响应速度慢等问题。“智慧声防”应急广播系统，通过智能化、网络化、多场景协同…...

编程日记 2025/8/20 12:42:10

linux-vi和文件操作

在 Linux 系统的世界里，有一个核心思想贯穿始终，那就是 “万物都是文件”。这一理念极大地简化了系统资源的管理和操作，为用户和开发者提供了统一且高效的交互方式。本文将深入探讨这一理念在 Linux 文件系统中的具体体现，从硬盘分…...

编程日记 2025/8/20 20:43:45

MIT6.S081 - Lab8 Locks（锁优化 | 并发安全）

本篇是 MIT6.S081 2020 操作系统课程 Lab8 的实验笔记，目标是在保证并发安全的前提下，重新设计内存分配器和块缓存这两个部分代码，提高系统并发性能。对于有项目经验的同学来说，实验的难度不算高，重点在于找出 “…...

编程日记 2025/8/26 4:42:03

TMS320F28P550SJ9学习笔记15：Lin通信SCI模式结构体寄存器

今日初步认识与配置使用Lin通信SCI模式，用结构体寄存器的方式编程文章提供完整工程下载、测试效果图我的单片机平台是这个： LIN通信引脚： LIN通信PIE中断： 这个 PIE Vector Table 表在手册111页： 这是提到LINa的PI…...

编程日记 2025/8/25 19:00:55

JavaWeb 课堂笔记 —— 11 MySQL 多表设计

本系列为笔者学习JavaWeb的课堂笔记，视频资源为B站黑马程序员出品的《黑马程序员JavaWeb开发教程，实现javaweb企业开发全流程（涵盖SpringMyBatisSpringMVCSpringBoot等）》，章节分布参考视频教程，为同样学习…...

编程日记 2025/8/25 21:23:41

2025年最新总结安全基础(面试题)

活动发起人@小虚竹想对你说：这是一个以写作博客为目的的创作活动，旨在鼓励大学生博主们挖掘自己的创作潜能，展现自己的写作才华。如果你是一位热爱写作的、想要展现自己创作才华的小伙伴，那么，快来参加吧！我们一起发掘写作的魅力，书写出属于我们的故事。我们诚挚邀请…...

编程日记 2025/8/23 14:22:33

调试chili3d笔记 typescript预习

https://github.com/xiangechen/chili3d 用firefox拓展附加进程打开开发者工具，这个网页按f12没反应，手动打开创建一个立方体可以看到运行了create.box方法，消息来自commandService.ts 位置太久没写c了，3目都看不懂了 c没有…...

编程日记 2025/8/23 10:12:23

【北交互联-注册/登录安全分析报告】

前言由于网站注册入口容易被黑客攻击，存在如下安全问题： 暴力破解密码，造成用户信息泄露短信盗刷的安全问题，影响业务及导致用户投诉带来经济损失，尤其是后付费客户，风险巨大，造成亏损无底洞…...

编程日记 2025/8/22 1:45:01

YOLOv2学习笔记

YOLOv2 背景 YOLOv2是YOLO的第二个版本，其目标是显著提高准确性，同时使其更快相关改进： 添加了BN层——Batch Norm采用更高分辨率的网络进行分类主干网络的训练 Hi-res classifier去除了全连接层，采用卷积层进行模型的输出&a…...

编程日记 2025/8/21 11:09:54

2025年国企社招欧治链金再生资源入职测评笔试中智赛码平台SHL测试平台Verify认知能力测试

1、欧治链金政治素质测试（中智赛码平台，电脑端作答） 10个单选题、5个多选题、1个问答题 2、欧治链金综合素质测试（SHL测试平台Verify认知能力测试，电脑端作答） 3、欧治链金职业性格测试（中智职…...

编程日记 2025/8/21 16:23:55

MySQL索引和事务

MySQL索引和事务 1.索引1.1概念1.2作用1.3使用场景1.4使用1.4.1查看索引1.4.2创建索引1.4.3删除索引 2.事务2.1使用2.1.1开启事务2.1.2执行多条SQL语句2.1.3回滚或提交 2.2事务的特性2.2.1回滚是怎么做到的2.2.2原子性2.2.3一致性2.2.4持久性2.2.5隔离性2.2.5.1脏读2.2.5.2不可…...

编程日记 2025/8/22 4:40:29

【AI News | 20250415】每日AI进展

AI News 1、字节跳动发布Seaweed-7B视频模型：70亿参数实现音视频同步生成与多镜头叙事字节跳动推出新一代视频生成模型Seaweed-7B，该模型仅70亿参数却实现多项突破：支持音视频同步生成、多镜头叙事（保持角色连贯性）、…...

编程日记 2025/8/25 18:27:46

MegaTTS3: 下一代高效语音合成技术，重塑AI语音的自然与个性化

在近期的发布中，浙江大学赵洲教授团队与字节跳动联合推出了革命性的第三代语音合成模型——MegaTTS3，该模型不仅在多个专业评测中展现了卓越的性能，还为AI语音的自然性和个性化开辟了新的篇章。 MegaTTS3技术亮点零样本语音合成 MegaTTS3采用…...

编程日记 2025/8/20 21:21:20

MyBatis-Plus 详解教程

文章目录 1. MyBatis-Plus 简介1.1 什么是 MyBatis-Plus？1.2 为什么要使用 MyBatis-Plus？传统 MyBatis 的痛点MyBatis-Plus 的优势 1.3 MyBatis-Plus 与 MyBatis 的关系 2. 快速开始2.1 环境要求2.2 依赖引入MavenGradle 2.3 数据库准备2.4 配置 Spring …...

编程日记 2025/8/23 7:22:38

Java设计模式之观察者模式：从入门到架构级实践

一、观察者模式的核心价值观察者模式（Observer Pattern）是行为型设计模式中的经典之作，它建立了对象间的一对多依赖关系，让多个观察者对象能够自动感知被观察对象的状态变化。这种模式在事件驱动系统、实时数据推送、GUI事件处理…...

编程日记 2025/8/21 11:30:34

【双指针】专题：LeetCode 202题解——快乐数

快乐数一、题目链接二、题目三、题目解析四、算法原理扩展五、编写代码一、题目链接快乐数二、题目三、题目解析快乐数的定义中第二点最重要，只有两种情况，分别拿示例1、示例2分析吧： 示例1中一旦出现1了，继续重复过程就…...

编程日记 2025/8/26 9:34:00

深度学习占用大量内存空间解决办法

应该是缓存的问题，关机重启内存多了10G，暂时没找到别的方法重启前关机重启后...

编程日记 2025/8/17 18:41:12

[LeetCode 1871] 跳跃游戏 7(Ⅶ)

题面： 数据范围： 2 ≤ s . l e n g t h ≤ 1 0 5 2 \le s.length \le 10^5 2≤s.length≤105 s [ i ] s[i] s[i] 要么是 ′ 0 ′ 0 ′0′ ，要么是 ′ 1 ′ 1 ′1′ s [ 0 ] 0 s[0] 0 s[0]0 1 ≤ m i n J u m p ≤ m a x J u m p <…...

编程日记 2025/8/26 1:27:10

同济大学轻量化低成本具身导航！COSMO：基于选择性记忆组合的低开销视觉语言导航

作者：Siqi Zhang 1 ^{1} 1, Yanyuan Qiao 3 ^{3} 3, Qunbo Wang 2 ^{2} 2, Zike Yan 4 ^{4} 4, Qi Wu 3 ^{3} 3, Zhihua Wei 1 ^{1} 1, Jing Liu 1 ^{1} 1单位： 1 ^{1} 1同济大学计算机科学与技术学院， 2 ^{2} 2中科院自动化研究所&#xff0…...

编程日记 2025/8/20 12:20:47

【Ubuntu | 网络】Vmware虚拟机里的Ubuntu开机后没有网络接口、也没有网络图标

😁博客主页😁：🚀https://blog.csdn.net/wkd_007🚀 🤑博客内容🤑：🍭嵌入式开发、Linux、C语言、C、数据结构、音视频🍭 😎金句分享😎&a…...

编程日记 2025/8/20 1:51:44

第二十一讲 XGBoost 回归建模 + SHAP 可解释性分析（利用R语言内置数据集）

下面我将使用 R 语言内置的 mtcars 数据集，模拟一个完整的 XGBoost 回归建模 SHAP 可解释性分析实战流程。我们将以预测汽车的油耗（mpg）为目标变量，构建 XGBoost 模型，并用 SHAP 来解释模型输出。 🚗 示例…...

编程日记 2025/8/23 19:46:22

HP惠普打印机：解决每次打印后额外产生@PJL SET USERNAME=文档的情况

情况描述惠普商用打印机型号：Color LaserJet Managed MFP E78223 在每次打印文档后都会出现包含我个人电脑用户名的额外文档： 这不是我希望的，因此我联系了惠普官方客服，并得到了解决解决方案原因具客服所说，这些是…...

编程日记 2025/8/22 13:49:38

MariaDB MaxScale 的用途与实现细节

MaxScale 主要用途 MariaDB MaxScale 是一个智能数据库代理（proxy），主要用于增强 MySQL/MariaDB 数据库的高可用性、可扩展性和安全性，同时简化应用程序与数据库基础设施之间的交互。它的核心功能包括： 负载均衡&…...

编程日记 2025/8/20 15:00:37

CTF--eval

一、原网页： 二、步骤： 1.代码分析： <?phpinclude "flag.php"; // 引入一个文件，该文件可能定义了一些变量（例如 $flag）$a $_REQUEST[hello]; // 从用户请求中获取参数 hello 的值&#x…...

编程日记 2025/8/25 16:19:35

Android学习总结之算法篇七（图和矩阵）

有向图的深度优先搜索（DFS）和广度优先搜索（BFS）的示例，以此来模拟遍历 GC Root 引用链这种有向图结构： 一、深度优先搜索（DFS） import java.util.*;public class GraphDFS {privat…...

编程日记 2025/8/22 21:53:05

vmcore分析锁问题实例（x86-64）

问题描述：系统出现panic，dmesg有如下打印： [122061.197311] task:irq/181-ice-enp state:D stack:0 pid:3134 ppid:2 flags:0x00004000 [122061.197315] Call Trace: [122061.197317] <TASK> [122061.197318] __schedule0…...

编程日记 2025/8/24 1:27:45

【vue3】vue3+express实现图片/pdf等资源文件的下载

文件资源的下载，是我们业务开发中常见的需求。作为前端开发，学习下如何自己使用node的express框架来实现资源的下载操作。实现效果代码实现前端 1.封装的请求后端下载接口的方法,需求配置aixos的请求参数里面的返回数据类型为blob // 下载 export…...

编程日记 2025/8/16 19:55:40

1. RESTful API (主流)

2. RPC（Remote Procedure Call）

3. GraphQL (新兴)

4. SOAP (传统)

5. WebSocket API

6. Webhook

风格对比表

如何选择 API 风格？

相关文章：