🗒️如何设计接口
2017-9-3
| 2023-5-14
0  |  0 分钟
password
Created time
May 14, 2023 07:51 AM
type
status
date
slug
summary
tags
category
icon
 
接口是用来系统间通信的定义,尤其异构系统之间的通信,接口的设计尤其重要。 ##一、 什么是好的接口? 对接口调用方来说:
  1. 定义清楚,易于理解,接口定义不晦涩难懂,命名按特定规则;错误处理完整;
  1. 调用简单,调用简单包括接口调用实现简单,数据定义简单(有的接口会定义入参长度必须满足N位,不足用某字符补充);还有业务逻辑实现简单,无需调用多个强依赖关系的接口;
  1. 扩展容易,接口新增字段,无需改动太多;
  1. 向下兼容,接口升级后,调用方不需要立即对接新的接口;
对接口设计者来说:
  1. 定义清晰,易于维护;
  1. 业务清晰,逻辑合理;
  1. 保持低耦合,高内聚,接口改动后对其他接口不要有影响;
  1. 易于扩展,支持需求变化。

二、接口设计原则

  1. 如无必要,不增接口;
  1. 单一职责;
  1. 高内聚,低耦合;
  1. 出入参定义清晰,命名统一;
  1. 复杂业务,有明确的业务流程图;
  1. 有统一的名词解释、数据字典;
  1. 清晰的返回状态及消息;
  1. 关键字段加密处理,统一的加密方式;
技术分享
  • API
  • Google:什么是数字化转型如何理解用户与客户?
    目录