所有文章 > 当前分类:API设计
Java 生鲜电商平台 - API 接口设计之 token、timestamp、sign 具体架构与实现
Java 生鲜电商平台 - API 接口设计之 token、timestamp、sign 具体架构与实现
2025/10/12
一:token 简介 Token:访问令牌access token, 用于接口中, 用于标识接口调用者的身份、凭证,减少用户名和密码的传输次数。一般情况下客户端(接口调用方)需要先向服务器端申请一个接口调用的账号,服务器会给出一个ap...
OpenAPI 和 JSON Schema:何时使用哪个
OpenAPI 和 JSON Schema:何时使用哪个
【API设计】 许多组织都有由 JSON Schema 描述的现有对象。但问题是,开发人员遇到了一个大问题:OpenAPI仍然无法识别和支持某些 JSON Schema 关键字。
2025/10/11
API 设计 101:从基础知识到最佳实践
API 设计 101:从基础知识到最佳实践
【API设计】 API设计是指设计应用程序编程接口(API)的过程。API是软件系统之间交互的桥梁,允许不同程序或系统通过一组预定义的规则和功能进行通信。设计API时,需考虑功能完整性、易用性、安全性和可扩展性。它定义了接口的结构、数据格式、操作方法等,确保开发者能高效、安全地调用功能,从而实现软件组件之间的无缝协作,提升软件开发效率和质量。
2025/10/10
用WhatsApp API发OTP验证码最全指南
用WhatsApp API发OTP验证码最全指南
【API设计】 在使用互联网应用程序的过程中,完成用户身份验证往往是必不可少的环节。常见的身份验证是在应用注册、登录、忘记密码等操作中,系统会向用户的手机发送一条验证码短信,并要求用户将验证码输入到相应的输入框中,从而完成身份识别操作。看起来虽然简单,但设...
2025/10/09
API 合同完整指南|设计、最佳实践与自动化应用解析
API 合同完整指南|设计、最佳实践与自动化应用解析
【API设计】 本文深入探讨了API合同的作用、其对业务的帮助、设计时的最佳实践以及实际应用示例。API合同确保开发人员能够以一致且可预测的方式与API交互,提升API的一致性和可靠性,简化开发流程、提高文档质量,并支持自动化测试。
2025/10/08
全面解析RESTful API设计规范:最佳实践与细节指南
全面解析RESTful API设计规范:最佳实践与细节指南
【API设计】 RESTful 是目前最流行的 API 设计规范,用于 Web 数据接口的设计。它的大原则容易把握,但是细节不容易做对。本文总结 RESTful 的设计细节,介绍如何设计出易于理解和使用的 API。 # URL设计 动词+宾语 ...
2025/10/08
vue 中 Axios 的封装和 API 接口的管理
vue 中 Axios 的封装和 API 接口的管理
【API设计】 一、axios的封装 在vue项目中,和后台交互获取数据这块,我们通常使用的是axios库,它是基于promise的http库,可运行在浏览器端和node.js中。他有很多优秀的特性,例如拦截请求和响应、取消请求、转换json、客户端...
2025/10/07
API 方法全解析|RESTful 开发者入门与最佳实践
API 方法全解析|RESTful 开发者入门与最佳实践
【API设计】 本指南为开发者提供了REST API方法的全面介绍,包括GET、POST、PUT、DELETE、PATCH、OPTIONS和HEAD等HTTP方法的核心特性及其应用场景。特别强调了正确选择API方法的重要性,如重发验证邮件应使用POST而非GET,以避免副作用。适合初学者系统学习API设计和开发。
2025/10/07
SpringBoot中REST API的错误异常处理设计
SpringBoot中REST API的错误异常处理设计
【API设计】 RESTful API中的异常Exception处理有两个基本要求,需要明确业务意义的错误消息以及http状态码。良好的错误消息能够让API客户端纠正问题。在本文中,我们将讨论并实现Spring的REST API异常处理。 Restf...
2025/10/06
Go工程化(五) API 设计下: 基于 protobuf 自动生成 gin 代码
Go工程化(五) API 设计下: 基于 protobuf 自动生成 gin 代码
【API设计】 方案设计 开始开发之前我们先看一下 gin 的路由是怎么注册的,以及 grpc 生成的接口格式是什么样的 gin example package main​import "github.com/gin-gonic/gin"...
2025/10/05
为开源项目 go-gin-api 增加 WebSocket 模块
为开源项目 go-gin-api 增加 WebSocket 模块
【API设计】 WebSocket 示例界面 第三方包 gorilla/websocket[1] websocket 链接时支持配置项: type Upgrader struct { // 指定升级 webso...
2025/10/04
Arazzo:OpenAPI 的工作流扩展规范
Arazzo:OpenAPI 的工作流扩展规范
【API设计】 Arazzo 是 OpenAPI 倡议推出的一项新规范,旨在描述和记录 API 中涉及多个操作的复杂工作流。通过声明式的语法,Arazzo 能够清晰地定义操作的输入、输出和步骤,支持复杂的条件判断和引用机制,为 API 文档和测试提供强大支持。
2025/10/04
使用Express.js构建一个简单的RESTful API,处理CRUD操作
使用Express.js构建一个简单的RESTful API,处理CRUD操作
【API设计】 在现代Web开发中,[RESTful]( [API]( scalability。今天,我们将一起学习如何使用Express.js构建一个简单的[RESTful]( API,处理基本的CRUD操作(创建、读取、更新和删除)。 ## 什么是E...
2025/10/03
使用 ChatGPT 和 json-server 快速实现 mock API
使用 ChatGPT 和 json-server 快速实现 mock API
【API设计】 本文翻译自 Rapid Mock API creation with ChatGPT and json-server,点击底部 “阅读原文” 可阅读原文。本文主要介绍如何使用 ChatGPT 和 json-server 快速实现 mock ...
2025/10/02
如何使用JavaScript、Node.js和Express.js构建REST API
如何使用JavaScript、Node.js和Express.js构建REST API
【API设计】 我将所有这些经验(好的和坏的)合并成一篇易于理解的文章,同时提供了一个可以遵循的实际示例。最后,我们将构建一个完整的 API,同时实施一个又一个的最佳实践。
2025/10/01
OpenAPI驱动的API设计
OpenAPI驱动的API设计
【API设计】 OpenAPI 规范是设计 API 的最著名方法之一。OAS 指定了描述 API 接口所需的规则和语法。在撰写本文时,我们使用的是 OAS 的第三个版本。
2025/09/30