所有文章 > 当前分类:API设计
PHP写一个 Api接口需要注意哪些?
PHP写一个 Api接口需要注意哪些?
2024/11/27
随着互联网的飞速发展,前后端分离的开发模式越来越流行。编写一个稳定、可靠和易于使用的 API 接口是现代互联网应用程序的关键。本文将介绍在使用 thinkphp6 框架开发 API 接口时需要注意的要点和考虑的问题,并提供详细的逻辑步骤和代...
axios中restful api的使用
axios中restful api的使用
【API设计】 1引子 在前端发送网络请求的时候,现在最经常使用的是axios, 而axios的api中我们(确切说是我)最常用的就是post,而其他api很少有用到的场景。最近在做一个简单需求(增删改查)的时候,后端给的接口是restful风格的。...
2024/11/27
在 Rust 中支持异步和同步代码
在 Rust 中支持异步和同步代码
【API设计】 介绍 想象一下,你打算用 Rust 创建一个新库。这个库的唯一功能就是封装一个你需要的公共 API, 比如  Spotify API 或者ArangoDB之类的数据库。这并不是造火箭,你也不是在发明什么新东西或者处理复杂的算法,所以你...
2024/11/27
深入探索 Rust Salvo:从简单博客系统到完整 RESTful API 的实战项目
深入探索 Rust Salvo:从简单博客系统到完整 RESTful API 的实战项目
【API设计】 摘要 本文通过实战项目深入探讨 Rust Salvo 框架的应用,详细介绍如何实现一个简单的博客系统,包括用户注册、登录和发布文章功能,以及如何构建一个完整的 RESTful API 并生成 API 文档(如 OpenAPI)。通过详...
2024/11/27
使用状态模式和零大小类型10倍提高Rust api性能
使用状态模式和零大小类型10倍提高Rust api性能
【API设计】 在这篇文章中,我们通过一步步实现一个真实项目的例子,来展示如何通过使用泛型、零大小类型及状态模式10倍提高Rust api的性能,同时还能防止API的使用者滥用API。这个项目是构建一个密码管理器的库。首先,我们定义一个名为Password...
2024/11/27
如何通过CD平台如何将数据以API的方式同步到facebook
如何通过CD平台如何将数据以API的方式同步到facebook
【API设计】 如何将CD转化通过API同步数据到fb  分为两步: 1.    添加affiliate的BM账户信息 2.    配置从CD平台传输到用户Event ...
2024/11/27
.NET云原生应用实践(二):Sticker微服务RESTful API的实现
.NET云原生应用实践(二):Sticker微服务RESTful API的实现
【API设计】 引言:应该使用ORM框架吗? 毋庸置疑,Sticker微服务需要访问数据库来管理“贴纸”(也就是“Sticker”),因此,以什么方式来存储数据,就是一个无法绕开的话题。如果你遵循领域驱动设计的思想,那么你可以说,保存到数据库的数据,...
2024/11/27
Gin系列二:Gin搭建Blog API’s (二)
Gin系列二:Gin搭建Blog API’s (二)
【API设计】 涉及知识点 Gin:Golang 的一个微框架,性能极佳。 beego-validation:本节采用的 beego 的表单验证库,中文文档。 gorm,对开发人员友好的 ORM 框架,英文文档 com,一个小而美...
2024/11/26
Gin系列二:Gin搭建Blog API’s (一)
Gin系列二:Gin搭建Blog API’s (一)
【API设计】 思考 首先,在一个初始项目开始前,大家都要思考一下 程序的文本配置写在代码中,好吗? API 的错误码硬编码在程序中,合适吗? db 句柄谁都去Open,没有统一管理,好吗? 获取分页等公共参数,谁都自己写一...
2024/11/26
从gin框架看如何构建自己的http服务框架
从gin框架看如何构建自己的http服务框架
【API设计】 一、 背景 gin框架作为一个普遍使用的http服务开源框架,为了能更好地使用它,我们有必要对gin框架有个清晰的认识,了解框架中请求处理流程、中间件执行等细节。gin框架基于golang基础库 net/http 进行开发,先了解 n...
2024/11/26
Go工程化(四) API 设计上: 项目结构 & 设计
Go工程化(四) API 设计上: 项目结构 & 设计
【API设计】 序 在 Go 工程化(二) 项目目录结构 中我们大概讲了一下 api 目录,但是并没有详细的说明,留在这这篇文章一起讲。 API 设计将分为四个部分: 首先会讲一下 API 的项目目录结构,在项目中 api 该如何组织,...
2024/11/26
PHP转Go系列 | ThinkPHP与Gin框架之API接口签名设计实践
PHP转Go系列 | ThinkPHP与Gin框架之API接口签名设计实践
【API设计】 数据安全一直是个热门的话题,API 接口在数据的传输上扮演着至关重要的角色。为了 API 接口的安全性、健壮性,完整性,往往需要将网络上的数据进行签名加密传输。同时为了防止 API 接口被重放爬虫伪造等类似恶意攻击的手段,还要在接口设计时增加有效时间、随机字符串、签名串等参数,来保障数据的安全性。这一次的 API 接口签名设计实践,大家也可以手动尝试实验一下,希望对大家的日常工作能有所帮助。
2024/11/25
如何在软件开发中实施API First标准
如何在软件开发中实施API First标准
【API设计】 API 优先方法强调在软件开发生命周期伊始就将 API 设计与创建置于核心地位,将其视为决定其他应用程序代码开发的基础组件,从而确保服务之间的一致性与可重用性,为应用程序带来可扩展性、灵活性以及与微服务架构的无缝集成等显著优势。有效的 API 优先策略实施涵盖全面的文档、标准化的错误处理和强大的 API 治理,这不仅培养了更佳的开发人员体验、激发创新活力,还使得 API 能够在组织内跨不同语言和平台实现无缝交互,支持无依赖项的升级与更新,极大地增强了系统的健壮性与灵活性。尽管在采用 API 优先实践过程中可能存在诸如文化转变、技术多样性管理等挑战,但其带来的显著架构优势不容小觑,能够加快产品上市时间、实现经济高效的应用程序开发,推动组织在激烈的市场竞争中保持领先,引领软件开发迈向更具前瞻性与战略性的新阶段。
2024/11/22
百亿规模API网关服务Shepherd的设计与实现
百亿规模API网关服务Shepherd的设计与实现
【API设计】 API网关是随着微服务概念兴起的一种架构模式。原本一个庞大的单体应用(All in one)业务系统被拆分成许多微服务系统进行独立的维护和部署,服务拆分带来的变化是API的规模成倍增长,API的管理难度也在日益增加,使用API网关发布和管理API逐渐成为一种趋势。一般来说,API网关是运行于外部请求与内部服务之间的一个流量入口,实现对外部请求的协议转换、鉴权、流控、参数校验、监控等通用功能。
2024/11/21
我们应该如何用好 AI?从 ChatGPT 到编程语言、大数据、前端
我们应该如何用好 AI?从 ChatGPT 到编程语言、大数据、前端
【API产品】 2022 年是科技圈艰难的一年,很少有振奋人心的消息。惊喜的是年底 OpenAI 开放的 ChatGPT,一下点燃了整个科技圈,体验后感觉有点像人脑,智能化程度惊艳。曾经我和朋友常调侃人工智能就是“有多少人工,就有多少智能”,ChatGPT...
2024/11/21
18个最佳API设计规范实践
18个最佳API设计规范实践
【API设计】 文章总结了API设计中应遵循的重要原则。首先强调了签名的重要性,通过将请求参数、时间戳和密钥拼接后进行hash算法处理生成签名,以防止数据被篡改,并通过时间戳限制请求的有效期。在数据安全方面,建议对敏感数据进行加密,如使用AES对称加密算法保护用户密码等重要信息。此外,文章还提出了其他设计要点,包括设置IP白名单以限制访问来源、实施限流策略以避免服务过载、进行严格的参数校验以拦截无效请求、统一返回值和异常处理以简化维护工作、记录详细的请求日志以便快速定位问题、设计幂等接口以避免重复操作、限制批量接口的记录条数以防止超时、进行压力测试以评估接口性能、采用异步处理以提升性能、对敏感数据进行脱敏处理以保护隐私、提供完整的接口文档以降低对接成本、合理选择请求方式、利用请求头传递公共参数、设计批量接口以提高通用性以及遵循职责单一原则以降低维护难度。这些军规旨在帮助开发者设计出更安全、高效、易维护的API接口。
2024/11/21
1 9 10 11 12 13 16