接口设计原则指南：设计易用的API

于 2025-09-22 11:02:05 发布
阅读量963 收藏 22
点赞数 10
CC 4.0 BY-SA版权
分类专栏： 代码设计艺术：从函数到架构 文章标签： c语言 代码规范 设计规范 架构
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/fh_1998/article/details/151957644

接口设计原则指南：设计易用的API

📖 你有没有遇到过这些问题？

想象一下这些生活场景：

场景1：使用家电

电器A：按钮标识不清，操作复杂，说明书厚如字典
电器B：按钮直观，操作简单，一看就会用

哪个用户体验更好？

场景2：驾驶汽车

汽车A：每个品牌的操作完全不同，换车就要重新学习
汽车B：油门、刹车、方向盘位置标准化，任何车都能开

哪种设计更合理？

在编程中，接口设计就像家电操作和汽车驾驶一样重要！

糟糕的接口设计像复杂的电器一样让人困惑：

// ❌ 接口设计混乱，难以理解和使用
// 参数顺序不合理，类型不明确
int sensor_read(int type, float *val, int *err, char *buf, int len, bool chk);

// 返回值含义不清
int process_data(void *data); // 返回什么？0是成功还是失败？

// 函数名不一致
void InitSensor(void);
int sensor_start(void);
bool SensorStop(void);
float getSensorValue(void);

// 参数过多，难以记忆
void configure_sensor(int id, float min, float max, int samples, 
                     bool enable, int mode, float offset, 
                     int filter_type, bool auto_cal);

优秀的接口设计像直观的家电一样简单易用：

// ✅ 接口设计清晰，易于理解和使用
// 命名一致，语义明确
bool Sensor_Init(void);
bool Sensor_Start(void);
void Sensor_Stop(void);
SensorData_t Sensor_ReadData(void);

// 参数合理，类型明确
typedef struct
{
    float min_value;
    float max_value;
    uint16_t sample_count;
    bool auto_calibration;
} SensorConfig_t;

bool Sensor_Configure(const SensorConfig_t *config);

// 错误处理清晰
typedef enum
{
    SENSOR_RESULT_SUCCESS = 0,
    SENSOR_RESULT_ERROR_NOT_INITIALIZED,
    SENSOR_RESULT_ERROR_INVALID_PARAM,
    SENSOR_RESULT_ERROR_HARDWARE_FAULT
} SensorResult_t;

SensorResult_t Sensor_GetLastError(void);

本文将详细介绍接口设计的原则和最佳实践，帮助开发者设计出易用、可维护的API接口。

🎯 为什么接口设计很重要？

生活中的例子

场景1：手机界面设计

手机A：功能按钮散乱，操作逻辑复杂，学习成本高
手机B：界面直观，操作一致，老人小孩都会用

场景2：工具设计

工具A：握把不舒适，操作费力，容易出错
工具B：人体工学设计，操作顺手，效率很高

良好接口设计的价值

  1. 降低学习成本：直观的接口容易理解和使用
  2. 减少使用错误：清晰的接口避免误用
  3. 提高开发效率：好用的接口让开发更快
  4. 便于维护扩展：稳定的接口支持长期演进

🌟 接口设计基本原则

1. 简单性原则

接口应该简单直观
// ❌ 接口过于复杂
typedef struct
{
    int (*init)(void *ctx, int flags, void *params, size_t size);
    int (*read)(void *ctx, void *buf, size_t len, int timeout, int *actual);
    int (*write)(void *ctx, const void *buf, size_t len, int flags, int *actual);
    int (*control)(void *ctx, int cmd, void *arg1, void *arg2, void *arg3);
    void (*cleanup)(void *ctx, int flags);
} ComplexInterface_t;

// ✅ 接口简单清晰
typedef struct
{
    bool (*init)(void);
    bool (*read)(uint8_t *data, size_t *length);
    bool (*write)(const uint8_t *data, size_t length);
    void (*deinit)(void);
} SimpleInterface_t;

// 复杂配置用专门的结构体
typedef struct
{
    uint32_t baudrate;
    uint8_t data_bits;
    uint8_t stop_bits;
    ParityType_t parity;
    uint32_t timeout_ms;
} UartConfig_t;

bool Uart_Configure(const UartConfig_t *config);

2. 一致性原则

命名和行为保持一致
// ✅ 命名风格一致
// 所有模块都使用相同的命名模式
bool Led_Init(void);
bool Led_SetState(LedId_t id, LedState_t state);
LedState_t Led_GetState(LedId_t id);
void Led_Deinit(void);

bool Button_Init(void);
bool Button_IsPressed(ButtonId_t id);
ButtonState_t Button_GetState(ButtonId_t id);
void Button_Deinit(void);

bool Display_Init(void);
bool Display_ShowText(const char *text);
bool Display_Clear(void);
void Display_Deinit(void);

// ✅ 错误处理一致
// 所有模块都使用相同的错误处理方式
typedef enum
{
    MODULE_SUCCESS = 0,
    MODULE_ERROR_INVALID_PARAM,
    MODULE_ERROR_NOT_INITIALIZED,
    MODULE_ERROR_HARDWARE_FAULT,
    MODULE_ERROR_TIMEOUT
} ModuleResult_t;

ModuleResult_t Led_GetLastError(void);
ModuleResult_t Button_GetLastError(void);
ModuleResult_t Display_GetLastError(void);

3. 最小惊讶原则

接口行为应该符合直觉
// ❌ 违反直觉的接口设计
bool Sensor_Start(void);  // 返回false表示启动成功？
int Buffer_Add(void *item); // 返回-1表示成功？
void Timer_Stop(void);    // 停止定时器但不重置计数？

// ✅ 符合直觉的接口设计
bool Sensor_Start(void);  // 返回true表示启动成功
bool Buffer_Add(const void *item); // 返回true表示添加成功
void Timer_Stop(void);    // 停止定时器
void Timer_Reset(void);   // 重置定时器计数

// 清晰的语义
bool IsEmpty(void);       // 明确返回是否为空
size_t GetCount(void);    // 明确返回数量
void Clear(void);         // 明确清空操作

4. 完整性原则

提供完整的功能集合
// ✅ 完整的文件操作接口
typedef enum
{
    FILE_MODE_READ = 0,
    FILE_MODE_WRITE,
    FILE_MODE_APPEND
} FileMode_t;

typedef struct File File_t;

// 基本操作
File_t* File_Open(const char *filename, FileMode_t mode);
void File_Close(File_t *file);

// 读写操作
size_t File_Read(File_t *file, void *buffer, size_t size);
size_t File_Write(File_t *file, const void *data, size_t size);

// 位置操作
bool File_Seek(File_t *file, long offset, int whence);
long File_Tell(File_t *file);
void File_Rewind(File_t *file);

// 状态查询
bool File_IsEOF(File_t *file);
bool File_HasError(File_t *file);
size_t File_GetSize(File_t *file);

// 缓冲控制
void File_Flush(File_t *file);

🎨 接口设计模式

1. 工厂模式接口

对象创建接口
// sensor_factory.h - 传感器工厂接口
typedef enum
{
    SENSOR_TYPE_TEMPERATURE = 0,
    SENSOR_TYPE_PRESSURE,
    SENSOR_TYPE_HUMIDITY,
    SENSOR_TYPE_FLOW
} SensorType_t;

typedef struct Sensor Sensor_t;

// 工厂接口
Sensor_t* SensorFactory_Create(SensorType_t type);
void SensorFactory_Destroy(Sensor_t *sensor);

// 传感器通用接口
bool Sensor_Initialize(Sensor_t *sensor);
bool Sensor_Read(Sensor_t *sensor, float *value);
bool Sensor_Calibrate(Sensor_t *sensor, float reference);
SensorType_t Sensor_GetType(Sensor_t *sensor);
const char* Sensor_GetName(Sensor_t *sensor);

// 使用示例
void example_usage(void)
{
    // 创建不同类型的传感器
    Sensor_t *temp_sensor = SensorFactory_Create(SENSOR_TYPE_TEMPERATURE);
    Sensor_t *pressure_sensor = SensorFactory_Create(SENSOR_TYPE_PRESSURE);
    
    // 统一的操作接口
    Sensor_Initialize(temp_sensor);
    Sensor_Initialize(pressure_sensor);
    
    float temp_value, pressure_value;
    Sensor_Read(temp_sensor, &temp_value);
    Sensor_Read(pressure_sensor, &pressure_value);
    
    // 清理资源
    SensorFactory_Destroy(temp_sensor);
    SensorFactory_Destroy(pressure_sensor);
}

2. 回调接口模式

事件通知接口
// event_interface.h - 事件接口
typedef enum
{
    EVENT_SENSOR_DATA_READY = 0,
    EVENT_ALARM_TRIGGERED,
    EVENT_BUTTON_PRESSED,
    EVENT_TIMER_EXPIRED
} EventType_t;

typedef struct
{
    EventType_t type;
    uint32_t timestamp;
    void *data;
    size_t data_size;
} Event_t;

// 事件处理回调
typedef void (*EventHandler_t)(const Event_t *event, void *user_data);

// 事件管理接口
bool EventManager_Init(void);
bool EventManager_Subscribe(EventType_t type, EventHandler_t handler, void *user_data);
bool EventManager_Unsubscribe(EventType_t type, EventHandler_t handler);
bool EventManager_PublishEvent(EventType_t type, const void *data, size_t size);
void EventManager_ProcessEvents(void);
void EventManager_Deinit(void);

// 使用示例
void sensor_data_handler(const Event_t *event, void *user_data)
{
    if (event->type == EVENT_SENSOR_DATA_READY)
    {
        SensorData_t *data = (SensorData_t*)event->data;
        printf("传感器数据: 温度=%.1f°C\n", data->temperature);
    }
}

void setup_event_handling(void)
{
    EventManager_Init();
    EventManager_Subscribe(EVENT_SENSOR_DATA_READY, sensor_data_handler, NULL);
}

3. 流式接口模式

链式调用接口
// builder_interface.h - 构建器接口
typedef struct ConfigBuilder ConfigBuilder_t;

// 链式调用接口
ConfigBuilder_t* ConfigBuilder_Create(void);
ConfigBuilder_t* ConfigBuilder_SetBaudrate(ConfigBuilder_t *builder, uint32_t baudrate);
ConfigBuilder_t* ConfigBuilder_SetDataBits(ConfigBuilder_t *builder, uint8_t bits);
ConfigBuilder_t* ConfigBuilder_SetStopBits(ConfigBuilder_t *builder, uint8_t bits);
ConfigBuilder_t* ConfigBuilder_SetParity(ConfigBuilder_t *builder, ParityType_t parity);
ConfigBuilder_t* ConfigBuilder_SetTimeout(ConfigBuilder_t *builder, uint32_t timeout_ms);
UartConfig_t* ConfigBuilder_Build(ConfigBuilder_t *builder);
void ConfigBuilder_Destroy(ConfigBuilder_t *builder);

// 使用示例 - 链式调用
void example_builder_usage(void)
{
    UartConfig_t *config = ConfigBuilder_Create()
        ->SetBaudrate(115200)
        ->SetDataBits(8)
        ->SetStopBits(1)
        ->SetParity(PARITY_NONE)
        ->SetTimeout(1000)
        ->Build();
    
    Uart_Configure(config);
    
    // 清理资源
    free(config);
}

📋 接口文档化最佳实践

1. 完整的接口文档

详细的函数文档
/**
 * @brief 初始化传感器模块
 * @details 初始化指定类型的传感器，配置硬件接口和默认参数
 * 
 * @param type 传感器类型，参见 SensorType_t 枚举
 * @param config 传感器配置参数，不能为NULL
 * 
 * @return 操作结果
 * @retval SENSOR_SUCCESS 初始化成功
 * @retval SENSOR_ERROR_INVALID_TYPE 不支持的传感器类型
 * @retval SENSOR_ERROR_INVALID_PARAM 配置参数无效
 * @retval SENSOR_ERROR_HARDWARE_FAULT 硬件故障
 * 
 * @note 调用此函数前必须先调用 Sensor_SystemInit()
 * @warning config参数不能为NULL，否则会导致未定义行为
 * 
 * @example
 * @code
 * SensorConfig_t config = {
 *     .sample_rate = 10,
 *     .resolution = SENSOR_RESOLUTION_12BIT,
 *     .filter_enable = true
 * };
 * 
 * SensorResult_t result = Sensor_Init(SENSOR_TYPE_TEMPERATURE, &config);
 * if (result != SENSOR_SUCCESS) {
 *     printf("传感器初始化失败: %d\n", result);
 * }
 * @endcode
 * 
 * @see Sensor_SystemInit(), Sensor_Deinit(), SensorConfig_t
 * @since v1.0.0
 */
SensorResult_t Sensor_Init(SensorType_t type, const SensorConfig_t *config);

/**
 * @brief 读取传感器数据
 * @details 从指定传感器读取最新的测量数据
 * 
 * @param type 传感器类型
 * @param[out] data 输出数据缓冲区，不能为NULL
 * @param[in,out] size 输入时为缓冲区大小，输出时为实际数据大小
 * 
 * @return 操作结果
 * @retval SENSOR_SUCCESS 读取成功
 * @retval SENSOR_ERROR_NOT_INITIALIZED 传感器未初始化
 * @retval SENSOR_ERROR_BUFFER_TOO_SMALL 缓冲区太小
 * @retval SENSOR_ERROR_NO_DATA 没有可用数据
 * 
 * @pre 传感器必须已经初始化
 * @post 如果成功，data包含有效的传感器数据
 * 
 * @thread_safety 此函数不是线程安全的
 * @reentrant 此函数不可重入
 */
SensorResult_t Sensor_ReadData(SensorType_t type, void *data, size_t *size);

2. 接口使用示例

完整的使用示例
/**
 * @file sensor_example.c
 * @brief 传感器接口使用示例
 * @details 展示如何正确使用传感器接口进行数据采集
 */

#include "sensor_interface.h"
#include <stdio.h>
#include <stdlib.h>

/**
 * @brief 传感器使用示例
 * @details 演示传感器的完整使用流程
 */
void sensor_usage_example(void)
{
    SensorResult_t result;
    SensorData_t sensor_data;
    
    // 1. 系统初始化
    result = Sensor_SystemInit();
    if (result != SENSOR_SUCCESS)
    {
        printf("系统初始化失败: %d\n", result);
        return;
    }
    
    // 2. 配置传感器
    SensorConfig_t config = {
        .sample_rate = 10,           // 10Hz采样率
        .resolution = SENSOR_RESOLUTION_12BIT,
        .filter_enable = true,       // 启用滤波
        .auto_calibration = false    // 关闭自动校准
    };
    
    // 3. 初始化温度传感器
    result = Sensor_Init(SENSOR_TYPE_TEMPERATURE, &config);
    if (result != SENSOR_SUCCESS)
    {
        printf("温度传感器初始化失败: %d\n", result);
        goto cleanup_system;
    }
    
    // 4. 启动传感器
    result = Sensor_Start(SENSOR_TYPE_TEMPERATURE);
    if (result != SENSOR_SUCCESS)
    {
        printf("温度传感器启动失败: %d\n", result);
        goto cleanup_sensor;
    }
    
    // 5. 数据采集循环
    for (int i = 0; i < 100; i++)
    {
        size_t data_size = sizeof(sensor_data);
        result = Sensor_ReadData(SENSOR_TYPE_TEMPERATURE, &sensor_data, &data_size);
        
        if (result == SENSOR_SUCCESS)
        {
            printf("温度: %.2f°C, 时间戳: %lu\n", 
                   sensor_data.temperature, sensor_data.timestamp);
        }
        else if (result == SENSOR_ERROR_NO_DATA)
        {
            printf("暂无数据，等待中...\n");
        }
        else
        {
            printf("读取数据失败: %d\n", result);
            break;
        }
        
        // 延时100ms
        Delay_Ms(100);
    }
    
    // 6. 清理资源
    Sensor_Stop(SENSOR_TYPE_TEMPERATURE);
    
cleanup_sensor:
    Sensor_Deinit(SENSOR_TYPE_TEMPERATURE);
    
cleanup_system:
    Sensor_SystemDeinit();
}

/**
 * @brief 错误处理示例
 * @details 展示如何处理各种错误情况
 */
void error_handling_example(void)
{
    SensorResult_t result;
    
    result = Sensor_Init(SENSOR_TYPE_TEMPERATURE, NULL);
    
    switch (result)
    {
        case SENSOR_SUCCESS:
            printf("初始化成功\n");
            break;
            
        case SENSOR_ERROR_INVALID_PARAM:
            printf("错误: 参数无效，请检查配置\n");
            break;
            
        case SENSOR_ERROR_HARDWARE_FAULT:
            printf("错误: 硬件故障，请检查连接\n");
            break;
            
        case SENSOR_ERROR_NOT_SUPPORTED:
            printf("错误: 不支持的传感器类型\n");
            break;
            
        default:
            printf("未知错误: %d\n", result);
            break;
    }
    
    // 获取详细错误信息
    const char *error_msg = Sensor_GetErrorString(result);
    printf("错误描述: %s\n", error_msg);
}

🔧 接口版本管理

1. 版本兼容性设计

向后兼容的接口演进
// version 1.0 - 初始接口
typedef struct
{
    float temperature;
    uint32_t timestamp;
} SensorData_v1_t;

bool Sensor_ReadData_v1(SensorData_v1_t *data);

// version 2.0 - 扩展接口（向后兼容）
typedef struct
{
    float temperature;
    uint32_t timestamp;
    // 新增字段
    float humidity;
    bool is_valid;
    uint16_t error_code;
} SensorData_v2_t;

// 保持旧接口可用
bool Sensor_ReadData_v1(SensorData_v1_t *data);

// 新接口
bool Sensor_ReadData_v2(SensorData_v2_t *data);

// 推荐的新接口（默认版本）
#define Sensor_ReadData Sensor_ReadData_v2

// version 3.0 - 重构接口（提供迁移路径）
typedef enum
{
    SENSOR_API_VERSION_1 = 1,
    SENSOR_API_VERSION_2 = 2,
    SENSOR_API_VERSION_3 = 3
} SensorApiVersion_t;

// 版本查询
SensorApiVersion_t Sensor_GetApiVersion(void);

// 设置兼容模式
bool Sensor_SetCompatibilityMode(SensorApiVersion_t version);

2. 接口废弃管理

优雅的接口废弃
// deprecated_interface.h - 废弃接口管理
#include "compiler_attributes.h"

// 标记废弃的接口
DEPRECATED("Use Sensor_ReadData_v2() instead")
bool Sensor_ReadData_v1(SensorData_v1_t *data);

DEPRECATED("Use Sensor_Configure() instead")
void Sensor_SetSampleRate(int rate);

// 编译时警告宏
#define DEPRECATED(msg) __attribute__((deprecated(msg)))

// 运行时废弃警告
static inline void deprecated_warning(const char *old_func, const char *new_func)
{
    static bool warned = false;
    if (!warned)
    {
        printf("警告: %s 已废弃，请使用 %s\n", old_func, new_func);
        warned = true;
    }
}

// 废弃接口的实现
bool Sensor_ReadData_v1(SensorData_v1_t *data)
{
    deprecated_warning("Sensor_ReadData_v1", "Sensor_ReadData_v2");
    
    // 调用新接口实现
    SensorData_v2_t new_data;
    bool result = Sensor_ReadData_v2(&new_data);
    
    if (result && data)
    {
        data->temperature = new_data.temperature;
        data->timestamp = new_data.timestamp;
    }
    
    return result;
}

📚 参考资料

API设计

  1. API Design Patterns - API设计模式
  2. RESTful API Design - RESTful API设计
  3. Google API Design Guide - Google API设计指南
  4. Microsoft API Guidelines - 微软API指南

软件接口

  1. Interface Design Principles - 接口设计原则
  2. Clean Code - Interfaces - 整洁代码中的接口
  3. Effective C - API Design - 高效C语言API设计
  4. C Interfaces and Implementations - C语言接口与实现

文档化

  1. Doxygen Documentation - Doxygen文档工具
  2. API Documentation Best Practices - API文档最佳实践
  3. Technical Writing - 技术写作指南
  4. Code Documentation - 代码文档化

🏷️ 总结

接口设计就像产品的用户手册：

  • 简单直观让用户容易上手
  • 保持一致让用户形成习惯
  • 功能完整让用户满足需求
  • 文档清晰让用户正确使用

核心原则：

  1. 简单性 > 复杂性
  2. 一致性 > 随意性
  3. 直观性 > 意外性
  4. 完整性 > 残缺性

记住这个公式：

优秀的接口设计 = 简单直观 + 保持一致 + 功能完整 + 文档清晰

通过本文的学习，我们了解了接口设计的原则和最佳实践，掌握了设计易用API的方法。

优秀的接口设计是软件成功的关键，让你的代码像优雅的产品一样易用！ 🔌

接口设计的原则：构建优雅API的完整指南
是大毛啊的博客
06-24 665
接口设计是定义系统不同组件之间交互方式的过程。它包括方法签名、参数定义、返回值、异常处理等方面的设计。好的接口设计能够隐藏实现细节，提供清晰的调用方式。每个接口应该只负责一个明确的功能，不应该承担多个不相关的职责。这是接口设计的基础原则。接口应该对扩展开放，对修改关闭。设计时要考虑未来的扩展需求，避免频繁修改已有接口。子类对象应该能够替换父类对象，而不影响程序的正确性。接口的实现类应该完全遵循接口的契约。不应该强迫客户依赖于它们不使用的方法。设计小而专一的接口，而不是大而全的接口。
接口设计六大原则
weixin_33841503的博客
07-27 1974
2019独角兽企业重金招聘Python工程师标准>>> ...
接口设计原则和方法.docx
05-13
Java接口开发原则和方法定义，为项目开发过程提供文档规范支持
接口设计原则文档
10-05
描述两个程序间通信时要注意的接口设计问题。
接口的设计原则
zb6340430的博客
12-05 932
遵循REST架构风格，使用合适的HTTP方法（GET、POST、PUT、DELETE等）来实现资源的增删改查，使用URI标识资源，使用状态码表示操作结果等。通过遵循这些接口设计原则，可以设计出高质量、易用、可扩展和可靠的API接口，提供给用户出色的开发体验和稳定的服务质量。设计高性能的接口，减少响应时间，减少网络开销，使用缓存等方式提高接口性能。接口应该易于使用，提供清晰的文档和示例，并考虑用户的需求和使用场景。接口应该易于阅读和理解，使用清晰的命名和注释，以及一致的代码风格。
基于JavaScript的无偿献血系统API接口设计源码
09-29
整个项目的设计遵循了Web API接口设计的最佳实践，如RESTful原则，确保API接口的统一性、简洁性和可扩展性。通过这样的设计，无偿献血系统的外部用户如政府机关、医疗机构、社区组织和普通民众，都能够通过标准化的...
基于Python和Shell开发的公开API接口设计源码
10-03
该项目是一个以API接口设计为核心的开发项目，使用了Python和Shell作为主要开发语言。在当今数字化时代，API（应用程序接口）作为一种使不同软件组件之间能够相互通信的方式，扮演着至关重要的角色。一个良好的API...
架构师必备技能指南：SaaS(软件即服务)架构设计
01-27
租户无需在本地设备上安装或管理软件，而是通过浏览器或其他Web接口访问所需应用。这种模式简化了软件的获取和使用，同时也为提供商提供了维护和更新的便利。 2. **为何选择SaaS架构** - **用户角度**：SaaS简化了...
淘宝订单API接口设计与应用实践指南
最新发布
2401_87966921的博客
02-20 1068
淘宝订单API接口是一组由淘宝提供的标准化网络接口，允许开发者通过编程方式访问和操作淘宝平台上的订单数据。数据获取：获取订单详情、订单列表、物流信息等。数据操作：创建订单、修改订单状态、取消订单等。业务协同：与第三方系统（如ERP、CRM、物流系统）进行数据交互，实现业务流程的自动化。淘宝订单API接口是连接淘宝平台与商家、开发者、第三方服务提供商的重要桥梁。通过合理设计和高效实现，API接口能够满足多样化的业务需求，提升电商运营效率和用户体验。
基于C#开发的外卖点餐小程序API接口设计源码
09-29
基于C#开发的外卖点餐小程序API接口设计源码项目提供了一套完整的解决方案，不仅包含了丰富的API接口供开发者使用，还提供了清晰的项目结构、详细的配置选项和必要的开发文档，为构建一个稳定、高效且易用的外卖点餐...
接口设计原则
chriscohen的博客
04-16 1003
接口设计原则有很多，这里总结出最主要的六种： 一、SRP 单一职责原则 定义：应该有且仅有一个原因引起类的变更。There should never be more than one reason for a class to change。       注意： 用职责或变化原因来衡量接口或类，但职责或变化原因都是不可度量的，因项目而异。 不能为了单一而单一，实现类就
接口开发原则
weixin_30951743的博客
09-10 117
在整个项目开发中，业务层开发是一个逻辑整合的过程，既参考前台展示又参考DB层的提取。 它是前台数据和DB数据相互转换的机器，既向前台提供系列接口，又调用DB提供的接口。 在接口定义中，又该如何把控。 个人建议： 1、接口有明确的目的 2、传入参数和传出参数要考虑接口的目的，不能整合代替 3、理解一目了然 举例： A、需要一个最近100条前台展示的列表 接口...
RESTful API设计原则与实践指南
RESTful API设计规范是一种软件架构风格，强调客户端和服务器之间的...遵循这些规范，有助于创建可维护、易用和适应变化的API接口，提高开发效率和用户体验。在实际设计时，应根据具体需求和项目特性灵活运用这些原则。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值