随着业务的发展，支撑平台的项目也是越来越多。 同时，为了让业务系统更加清晰，会从整个平台项目的架构体系，对系统业务水平拆分、垂直分层，产生了一系列平台和子系统，并使用接口进行数据交互。 伴随着业务的发展，接口文档会越来越多。 代码和文档不匹配，代码接口更新，文档不更新，且接口文…

我的一些 API 设计经验和观点

说一点勘误的点（重点在最后

RESTful 是目前最流行的 API 设计规范，用于 Web 数据接口的设计。它的大原则容易把握，但是细节不容易做对。 本文总结 RESTful 的设计细节，介绍如何设计出易于理解和使用的 API。 RESTful 的核心思想就是，客户端发出的数据操作指令都是"动词 + 宾语…

客户端在通过 API 与后端服务通信的过程中，应该 使用 HTTPS 协议。 所有的 API 必须保持向后兼容，你 必须 在引入新版本 API 的同时确保旧版本 API 仍然可用。所以 应该 为其提供版本支持。 其中 vnd 表示 Standards Tree 标准树类型，有三…

API与客户端通讯协议主要包含http和https，建议使用https确保交互数据的传输安全。 版本控制主要用于App、微信小程序、软件客户端等与系统不可同时实时更新的情况，来满足需要兼容旧版本的场景。 采用多版本并存，增量发布的方式。 这种方法比较方便和直观，版本号主要以整型…

“什么？”你发出惊叫。“GraphQL 是一个服务端查询语言，Redux 是一个客户端状态管理库，这两个风马牛不相及的东西怎么能互相代替？！” 这是个好问题。坐稳扶好了，因为我将正面回答，挑战你的三观。 迁移到 React 回答之前，先听我讲一下故事背景。早在 2016 …

现在流行云端化，前后端分离。要实现这样的设计就必须开发接口。接口开发就好比一个产品换了包装。业务逻辑上是没有任何变化的，唯一变化的就是数据接收和返回做了新的处理。接口开发需要注意以下几个基本点。 到底你是采用传统的风格，还是使用restful风格。这很重要，直接关系到你的接口长…