所有文章 > 当前分类:API设计
最流行的 RESTful API 要怎么设计?
最流行的 RESTful API 要怎么设计?
2024/12/19
RESTful 是目前最流行的 API 设计规范,用于 Web 数据接口的设计。它的大原则容易把握,但是细节不容易做对。本文总结 RESTful 的设计细节,介绍如何设计出易于理解和使用的 API。 URL设计 动词+宾语 ...
标准API接口设计规范
标准API接口设计规范
【API设计】 接口签名 接口签名是一种常见的安全措施,用于确保API请求的完整性和身份验证。 实现步骤 以下是实现接口签名的一般步骤: 参数收集:首先,收集所有将发送到API的参数,包括例如用户ID、操作类型、请求数据等。 ...
2024/12/19
阿里研究员谷朴:API 设计最佳实践的思考
阿里研究员谷朴:API 设计最佳实践的思考
【API设计】 谷朴 | 作者 「 阿里巴巴云原生」授权 API 是软件系统的核心,而软件系统的复杂度 Complexity 是大规模软件系统能否成功最重要的因素。但复杂度 Complexity 并非某一个单独的问题能完全败坏的,而是...
2024/12/19
全面解析RESTful API设计规范:最佳实践与细节指南
全面解析RESTful API设计规范:最佳实践与细节指南
【API设计】 RESTful 是目前最流行的 API 设计规范,用于 Web 数据接口的设计。它的大原则容易把握,但是细节不容易做对。本文总结 RESTful 的设计细节,介绍如何设计出易于理解和使用的 API。 # URL设计 动词+宾语 ...
2024/12/19
Flink编程API设计分析
Flink编程API设计分析
【API设计】 使用Flink开发批式或流式Job,除了基本的处理逻辑与实际应用场景相关,我们更关心的是Flink提供的基本框架,是如何在API层面进行统一处理的,或者说尽量使API统一,这样有助于我们对Flink框架更深入地理解。目前使用Flink 1....
2024/12/19
15 个REST API 设计的基本技巧
15 个REST API 设计的基本技巧
【API设计】 REST API 是最常见的 Web 服务类型之一,但它们也很难设计。它们允许各种客户端(包括浏览器、桌面应用程序、移动应用程序以及基本上任何具有互联网连接的设备)与服务器进行通信。因此,正确设计 REST API 非常重要,这样我们就不会...
2024/12/19
如何让 Python 写的 API 接口同时支持 Session 和 Token 认证?
如何让 Python 写的 API 接口同时支持 Session 和 Token 认证?
【API设计】 Django 是 Python 语言中最受欢迎的 Web 框架之一。其开箱即用的特性,使得我们可以利用它快速搭建一个传统的 Web 应用。在如今多端横行的互联网,单纯的传统 Web 应用开发已经越来越式微,更多的应用采用了前后端分离的 We...
2024/12/19
用 AWS Smithy 构建下一代 API 服务
用 AWS Smithy 构建下一代 API 服务
【API设计】 自动化代码生成这种能减少工作量的事情一直是程序员们的最爱。如果某些代码片段不断重复自身,我们会用宏替换来减少这种重复,但如果涉及到大规模,架构级别的重复,那么我们倾向于用代码生成来解决这种重复。日常工作中,大家使用得比较多的代码生成工具有 ...
2024/12/19
Flask-Limiter:为 API 添加访问速率限制的 Python 扩展!
Flask-Limiter:为 API 添加访问速率限制的 Python 扩展!
【API设计】 今天要给大家介绍一款在构建安全且稳定的 API 服务时非常实用的 Python 扩展——Flask-Limiter。它就如同一位严谨的 API 流量管家,能够精准地控制对 API 端点的访问速率,无论是防止恶意攻击、保护服务器资源,还是确保...
2024/12/19
分布式系统核心:REST风格的架构,REST成熟度模型及REST API管理
分布式系统核心:REST风格的架构,REST成熟度模型及REST API管理
【API设计】 ◆ 成熟度模型 正确、完整地使用REST是困难的,关键在于RoyFielding所定义的REST只是一种架构风格,它并不是规范,所以也就缺乏可以直接参考的依据。好在Leonard Richardson补充了这方面的不足。 他提出...
2024/12/19
API的性能约定
API的性能约定
【API设计】 当今,任何软件系统都依赖于其他人的工作,可以参考《没有被了解的API?一个老码农眼中的API世界》。当然,我们写了一些代码,通过API调用操作系统和各种软件包中的函数,从而减少了代码量。随着分布式系统的日益普遍,我们的软件系统通过网络与服务...
2024/12/19
IOT语义互操作性之API接口
IOT语义互操作性之API接口
【API设计】 这个系列文章描述了一个单一的语义数据模型来支持物联网和建筑、企业和消费者的数据转换。 这种模型必须简单可扩展, 以便能够在各行业领域之间实现插件化和互操作性。 对于一个目前从事智能硬件的老码农,觉得这些文字具有积极的参考意义。这一部分讨论通...
2024/12/19
没有被了解的API?一个老码农眼中的API世界
没有被了解的API?一个老码农眼中的API世界
【API设计】 即便做了20多年的软件开发,仍然发现自己经常会低估完成一个特定的编程任务所需要的时间。有时,错误的时间表是由于自己的能力不足造成的: 当深入研究一个问题时,会发现它比最初想象的要难得多,因此解决这个问题需要更长的时间ーー这就是程序员的生活。...
2024/12/19
浅谈四种API设计风格(RPC、REST、GraphQL、服务端驱动)
浅谈四种API设计风格(RPC、REST、GraphQL、服务端驱动)
【API设计】 Web API设计其实是一个挺重要的设计话题,许多公司都会有公司层面的Web API设计规范,几乎所有的项目在详细设计阶段都会进行API设计,项目开发后都会有一份API文档供测试和联调。本文尝试根据自己的理解总结一下目前常见的四种API设计...
2024/12/19
SpringBoot中REST API的错误异常处理设计
SpringBoot中REST API的错误异常处理设计
【API设计】 RESTful API中的异常Exception处理有两个基本要求,需要明确业务意义的错误消息以及http状态码。良好的错误消息能够让API客户端纠正问题。在本文中,我们将讨论并实现Spring的REST API异常处理。 Restf...
2024/12/18
Flask-RESTful:最强Python Web服务框架,轻松构建REST API
Flask-RESTful:最强Python Web服务框架,轻松构建REST API
【API设计】 Flask-RESTful:最强Python Web服务框架,轻松构建REST API Flask 是 Python 中最受欢迎的轻量级 Web 框架之一,而 Flask-RESTful 是 Flask 的一个扩展,专门用于快速构建 ...
2024/12/17