如何设计 API？看这一篇就够了

最新推荐文章于 2025-06-09 01:52:11 发布
最新推荐文章于 2025-06-09 01:52:11 发布
阅读量527 收藏 1
点赞数
CC 4.0 BY-SA版权
文章标签： API 前后端分离
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/Z__7Gk/article/details/133887343
本文探讨了在前后端分离设计中API设计所遇到的问题，如客户端差异化、效率低等，并提出通过API网关来解决。API网关负责路由请求、组合服务、提供专属API并具备扩展能力。介绍了Ocelot、Kong、Envoy等API网关的选择，并推荐了JNPF开发平台以提升开发效率。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

在前后端分离的设计中，不管使用什么语言，后端都需要提供 WebAPI 给前端使用。如果是一个平台级的产品，还有可能需要将平台的公共 API 提供给第三方系统使用，这些都要考虑到 API 的设计。

本文聊下 API 设计可能遇到的问题以及处理方式。

问题

1、客户端种类比较多，不容易实现差异化

以我们现在正在做的低代码平台来说，存在的客户端有下面这些：

  • Web 端应用程序
  • 移动端的应用程序
  • 第三方开发人员编写的应用程序
  • 自定义组件（符合规范的 Vue 前端组件，可以无缝和平台进行整合）
  • 平台配置的脚本（直接配置在平台中，可以调用接口、处理界面元素）

不同的客户端在调用接口时，输入输出会存在差异，比如：

最低0.47元/天 解锁文章

200万优质内容无限畅学
如何设计好API
小奇学编程的博客
09-26 1173
“语言首先是写给人看的，只是恰巧（incidentally）能够运行” ——《计算机程序的构造和解释》。 好的API应对客户端友好，换言之就是能够直接通过其方法签名而理解它做的事情，而不用深入去阅读方法的实现，甚至深入阅读API所在的整个类。 单纯的介绍如何设计好API似乎如"海市蜃楼"般的虚无缥缈，因此本文从设计&实现的角度出发，针对我们在设计并实现API的过程中提出一些小意见。 首先回顾一下API方法的组成模块： API注释 访问修饰符 返回值 方法名称 参数列表 异常列
Vue3+TypeScript？看这一篇就够了
m0_67266171的博客
03-01 3938
1、TypeScript快速上手 1.1 初识 TypeScript TypeScript 的介绍 TypeScript是一种由微软开发的开源、跨平台的编程语言。它是JavaScript的超集，最终会被编译为JavaScript代码。 2012年10月，微软发布了首个公开版本的TypeScript，2013年6月19日，在经历了一个预览版之后微软正式发布了正式版TypeScript TypeScript的作者是安德斯·海尔斯伯格，C#的首席架构师。它是开源和跨平台的编程语言。 TypeScript扩展了J
API的设计与实现
求索
06-24 1万+
关于API的设计与实现API的设计是软件开发中一个独特的领域。最主要的特殊点在于API是供开发者使用的界面，即Application Programmer Interfaces。所以相对于依据软件设计的原则，考虑用户的”体验”会更加重要。许多著名的工具和库的作者都写过相关的著作，详细的论述他们在API上的设计与实现要点。本文是尝试对前人工作的总结。
如何创建自己的API接口网站
最新发布
2301_80786092的博客
06-09 383
以我为例我需要构建一个可以调用诗词数据的api接口类似于。
浅谈API设计
weixin_33898233的博客
09-18 153
为什么需要了解一些API设计？ 只要你编程，你就是API Designer 一个好的设计，模块之间的耦合应该也是API级别的 一个程序，如果你独立开发，那你既是API的Designer，也是API的User 如果你和你的同事一起开发，，你既是你开发的模块API的Designer，也是其他同事模块API的User 一个好的API应该具备哪些特点？ 1. 易学易用（Easy to learn and...
API 设计以及思考
Zsd
05-27 439
背景 当一个系统运行一段时间以后，随着业务的变化，对外提供的 API 越来越多。 那么什么样的 API 是好的设计，什么样的 API 需要下掉或者重构掉。 这篇文章讨论的问题： API 应该尽量满足哪些规范。 如何设计一个 API。 如何重构一个不好的 API。 API 四个理念 在这里我参考一些资料和文章，试图总结一些好的 API 所具备的共性。 清晰 API 是用于程序之间的交互，对外提供服务。API 需要清晰表述提供了哪些能力，如何使用这些能力。不要出现歧义以及难以理解的情况。 使用者与维护者有
Dart学Dart？这一篇就够了！
04-05
这篇内容将深入探讨Dart的核心语法，帮助你全面理解并掌握这一语言。 首先，我们从基础开始。Dart是静态类型的，这意味着在编写代码时必须为每个变量指定类型。变量声明使用关键字`var`或指定类型，如`int`、`...
微服务架构组件分析，看这篇就够了
01-27
微服务架构是一种将大型应用程序分解为一组小型、独立的服务，每个服务都能独立开发、部署和扩展的架构模式。本文将深入探讨微服务架构中的关键组件，主要包括服务描述、服务注册与发现。 1. 服务描述 在微服务...
API设计
AJANEEE的博客
11-17 665
文章目录设计原则基本原则围绕资源组织 API：根据 HTTP 方法定义操作数据筛选和分页使用 HATEOAS 导航到相关资源一个博客网站的APICurrent versionSchema博客摘要博客详细内容认证方式基本认证登录失败参数root客户端错误HTTP verbs分页链接标题限速条件请求 设计原则 基本原则 使用 HTTP 设计 RESTful API 时的一些主要原则： REST A...
API（模块）设计之道（一）
热门推荐
跬步致远——Ai92
09-10 1万+
原文地址：How To Design a (module) API 翻译：Ai92     http://blog.youkuaiyun.com/ai92为什么需要API？ API是应用程序设计接口（Application Programming Interface）的缩写，在我们对如何编写API进行深入描述并给出建议之前，有必要来分析下这个术语的含义。  单词interface表示API
API接口设计
qq_31700775的博客
07-11 302
Token：访问令牌access token, 用于接口中,用于标识接口调用者的身份、凭证，减少用户名和密码的传输次数。一般情况下客户端(接口调用方)需要先向服务器端申请一个接口调用的账号，服务器会给出一个appId和一个key,key用于参数签名使用，注意key保存到客户端，需要做一些安全处理，防止泄露。
API接口的设计思路
WBKJ_Noah的博客
08-03 389
遵循RESTful原则、设计合理的请求和响应、版本控制、安全性和频率限制以及提供文档和示例都是良好的API接口设计规范。程序员应该遵循这些规范，以提高开发效率、减少问题和错误，并增强系统的可维护性和可扩展性。通过良好的API接口设计规范，我们可以构建出高质量、易于使用和理解的API。遵循RESTful原则有助于设计出简洁、可理解、可扩展的API接口。API接口设计是软件开发中非常重要的一环，良好的设计规范能够提高开发效率、减少问题和错误，并增强系统的可维护性和可扩展性。二、设计合理的请求和响应。
API设计与性能
spidercoco的专栏
05-28 208
当你设计新的API时你需要做很多决策。一般都是基于大量的设计原则来做出的这些决策。Joshua Bloch在他的[url=http://s.deepinmind.com/ppt/2014/05/28/how-to-design-a-good-api.html]报告[/url]中总结了一些。他提到的主要原则有以下这些： [*] 易于学习 [*] 易于使用 [*] 不易误用 [*] 写出的...
想学ESP8266？看一篇文就够了！快速学习ESP8266各功能 万字长文内含示例代码
01-12
### 关于ESP8266的全面学习资料 #### ESP8266简介与功能详解 ESP8266是一款专为物联网(IoT)设计的Wi-Fi模块，具备强大的网络连接能力。此款微控制器不仅支持TCP/IP协议栈还提供了一系列用于处理字符串的API接口以及最佳实践指导[^1]。 对于基于ESP8266的应用开发而言，理解其内置函数库至关重要。这些库涵盖了从基本的数据类型定义到复杂的网络编程等多个方面： - **字符串操作**：包括创建、复制、拼接等常见任务； - **内存管理**：动态分配和释放堆空间的方法； - **串口通讯**：通过UART与其他设备交换数据的技术细节； - **网络安全特性**：确保传输过程中的信息安全措施； - **性能调优技巧**：提高应用程序运行效率的方式； - **错误恢复机制**：当遇到意外情况时如何优雅地应对并恢复正常服务； 以上各项内容均能在官方文档中找到详尽描述，并配有实际案例供参考学习。 #### 示例代码展示 为了更好地掌握上述知识点，在这里给出一段简单的Python风格伪代码来说明怎样利用ESP8266发送HTTP请求获取网页内容: ```python import urequests as requests # 导入轻量级http客户端库 def fetch_webpage(url): try: response = requests.get(url) # 发送GET请求至指定URL if response.status_code == 200: # 如果状态码表示成功，则打印页面主体部分 print(response.text) response.close() # 记得关闭连接以节省资源 except Exception as e: print(f"Error occurred while fetching webpage: {e}") ``` 这段代码展示了如何使用`urequests`这个专门为MicroPython环境定制的小型化版本requests库来进行标准HTTP GET请求的操作流程。它能够有效地简化原本较为繁琐的过程，让开发者可以更专注于业务逻辑本身而不是底层实现。 另外，还有更多实用的例子可以在开源项目【ESP8266-Demos】里发现，该项目包含了多个不同场景下的具体实施方案，非常适合用来加深理解和练习技能[^2]。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值