所有文章 > 当前分类:API设计
「API 设计」7 步全流程指南:从需求到最佳实践,一篇就够!
「API 设计」7 步全流程指南:从需求到最佳实践,一篇就够!
2025/11/12
本文详细解析如何设计高效、可靠的API,涵盖核心设计原则与最佳实践,包括端点规划、安全性措施、版本控制、文档编写和测试步骤,帮助开发者创建满足用户需求且易于集成的API。
「API 设计」全景指南:从基础概念到高阶最佳实践,一篇就够!
「API 设计」全景指南:从基础概念到高阶最佳实践,一篇就够!
【API设计】 本文全面解析API设计的核心要点,从基础知识到最佳实践,涵盖RESTful原则、安全性、可扩展性和错误处理等关键方面。重点介绍如何设计易用、可靠且具有未来性的API,包括端点设计、模块化架构和文档自动生成等技术细节。适用于云计算、移动开发和分布式系统等场景。
2025/11/12
Web API 全景扫盲:4 大类型 + 3 大协议一次看懂,选型不迷路!
Web API 全景扫盲:4 大类型 + 3 大协议一次看懂,选型不迷路!
【API设计】 本文详细介绍了三种主要的API协议类型(REST、RPC、SOAP)及其区别与适用场景,帮助开发者选择最适合的通信方式。文章还分析了四种Web API类型(开放式API、内部API、合作伙伴API、复合API)的特点和应用实例,为构建现代化应用程序提供指导。
2025/11/09
REST API 设计全景指南:从资源定义到电商、社交、IoT 实战,一篇吃透!
REST API 设计全景指南:从资源定义到电商、社交、IoT 实战,一篇吃透!
【API设计】 REST API设计基于REST架构风格,通过无状态的客户端-服务器通信模型实现系统间高效数据交互。文章详细解析了RESTful API的核心原则,包括基于资源的设计、无状态通信和统一接口等关键特性,并探讨了其在电子商务、社交媒体和物联网等领域的实际应用场景。掌握REST API设计最佳实践对构建可扩展的分布式系统至关重要。
2025/11/09
RESTful API 三大基石:资源、表示、无状态 —— 概念梳理 + 实战示例一次掌握
RESTful API 三大基石:资源、表示、无状态 —— 概念梳理 + 实战示例一次掌握
【API设计】 本文深入解析RESTful API设计的三大核心要素:资源(URI标识)、表征(JSON/XML格式)和无状态性(独立请求)。通过HTTP方法操作自包含资源,利用内容协商机制实现客户端与服务器的灵活交互,构建可扩展的Web服务架构。掌握这些原则能帮助开发者设计高效可靠的API接口。
2025/11/09
「清洁 API 架构」六部曲·Part 1:分层全景 + Ruby 实战,告别“Fat Controller”!
「清洁 API 架构」六部曲·Part 1:分层全景 + Ruby 实战,告别“Fat Controller”!
【API设计】 本文介绍了Clean API架构的设计理念及其在Web API开发中的应用。Clean架构通过分层设计实现关注点分离,每一层遵循单一职责原则,提升代码可维护性和可测试性。文章详细阐述了控制器、请求对象、服务对象和实体逻辑层的职责,以及如何通过分层验证机制和异步队列处理构建高效API系统。
2025/11/08
API 总成本杀手:5 个让支持与维护费用飙升的设计误区及对策
API 总成本杀手:5 个让支持与维护费用飙升的设计误区及对策
【API设计】 本文探讨了API团队在设计和管理过程中可能导致成本增加的五个常见错误,包括忽视用户需求、错误的API样式选择、缺乏产品思维、频繁发布破坏性更新以及不完善的API文档。通过采用API外部设计、Align-Define-Design-Refine流程和产品思维等方法,团队可以有效降低API的拥有成本。
2025/11/07
把设计思维、领域故事与 API 需求一把抓:Will、Mary、George 三角色实战演练
把设计思维、领域故事与 API 需求一把抓:Will、Mary、George 三角色实战演练
【API设计】 本文探讨了设计思维在API设计中的应用,通过领域叙事方法深入分析用户需求与痛点。文章展示了一个IT顾问团队如何通过多领域协作,运用创新思维解决产品开发困境,并最终提出高效解决方案的案例。
2025/11/07
API 架构 101:从核心价值到事件驱动的全景指南
API 架构 101:从核心价值到事件驱动的全景指南
【API设计】 本文提供全面的API架构设计指南,涵盖从基础概念到高级实践。API作为企业数字化转型的核心工具,在微服务架构、API网关设计和RESTful标准应用中发挥关键作用。重点解析如何设计高效、安全的API架构以支持企业业务增长,包括API生命周期管理、安全策略和微服务集成等关键技术。
2025/11/05
集成DeepSeek-V3.1开源模型的平台API设计
集成DeepSeek-V3.1开源模型的平台API设计
【API设计】 📖 引言 随着大模型进入「多模态 + 工具链」时代,开发者对「低门槛、低延迟、低成本」调用开源模型的诉求越来越强烈。 DeepSeek-V3.1 作为 2025 年 6 月发布的 236B MoE 架构开源模型,在 MMLU、C-Eval ...
2025/10/20
API 设计原理:从理论到实践
API 设计原理:从理论到实践
【API设计】 本文深入探讨了API设计原理,从基本原则到常见模式,再到最佳实践和工具使用,全面解析了如何设计高效、易用且可扩展的API。文章强调了API设计原理中的一致性、简洁性、可扩展性和安全性,并通过RESTful API、GraphQL和RPC等实际代码示例,展示了不同API设计模式的应用场景和实现方法。此外,文章还介绍了Swagger、Postman等工具在API设计和文档生成中的重要作用。通过理论与实践的结合,本文为开发者提供了全面的API设计原理指导,帮助构建高质量的API,提升系统开发效率和可维护性。
2025/10/20
使用 Keycloak 与 API 网关保护你的 API
使用 Keycloak 与 API 网关保护你的 API
【API设计】 OpenID Connect 又名 OIDC,是基于 OAuth 2.0 的认证协议。它允许客户端从身份认证服务 IdP 获取用户基本信息,常见的 IdP 有:Keycloak、Ory、Okta、Auth0、Authing 等。 开源...
2025/10/16
阿里研究员谷朴:API 设计最佳实践的思考
阿里研究员谷朴:API 设计最佳实践的思考
【API设计】 谷朴 | 作者 「 阿里巴巴云原生」授权 API 是软件系统的核心,而软件系统的复杂度 Complexity 是大规模软件系统能否成功最重要的因素。但复杂度 Complexity 并非某一个单独的问题能完全败坏的,而是...
2025/10/15
如何使用DBAPI快速搭建自己的API平台
如何使用DBAPI快速搭建自己的API平台
【API设计】 在工作中,我们需要将数据库中的数据以api接口的形式返回json数据。这需要根据实际情况写相关的接口。不同的平台,选择的语言不尽相同。那么有没有更加简单的方法呢? 关于 DBAPI是一个面向数仓开发人员的低代码工具,只需在页面...
2025/10/14
Go工程化(四) API 设计上: 项目结构 & 设计
Go工程化(四) API 设计上: 项目结构 & 设计
【API设计】 序 在 Go 工程化(二) 项目目录结构 中我们大概讲了一下 api 目录,但是并没有详细的说明,留在这这篇文章一起讲。 API 设计将分为四个部分: 首先会讲一下 API 的项目目录结构,在项目中 api 该如何组织,...
2025/10/13
Java 生鲜电商平台 – API 接口设计之 token、timestamp、sign 具体架构与实现
Java 生鲜电商平台 – API 接口设计之 token、timestamp、sign 具体架构与实现
【API设计】 一:token 简介 Token:访问令牌access token, 用于接口中, 用于标识接口调用者的身份、凭证,减少用户名和密码的传输次数。一般情况下客户端(接口调用方)需要先向服务器端申请一个接口调用的账号,服务器会给出一个ap...
2025/10/12
1 4 5 6 7 8 17