接口设计的一些总结

最新推荐文章于 2022-05-11 12:40:53 发布

原创

最新推荐文章于 2022-05-11 12:40:53 发布 · 522 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#api #接口设计 #RESTful #后端

本文探讨了API接口设计中的一些常见问题，包括日期格式、ID处理、数据结构、错误处理、调用须知和文档展示。强调了接口设计的规范化、效率和安全性，建议使用ISO8601日期格式，保持ID的一致性，优化数据结构，明确错误处理策略，以及提供清晰的调用指南和文档。此外，还提到了鉴权方法如Basic Authorization、OAuth Token和Session。

接口是计算机通信的一种抽象概念，实现接口的方式有很多种，下面我们就基于 http/https 的接口进行讨论

api接口请求与返回

参考 How NOT to design APIs 进行总结

作者的朋友的项目正在使用 Beds24 这套系统，这套系统主要就是用来做预定的，连接的是Booking\AirBnB上的房源信息。而这个项目的功能就是从一些订房平台上获取可供预定的房间和日期。

但是这个提供的接口服务存在着很多问题，所以作者就拿他作为反面教材愉快地吐槽了一番。

我们先来看一下一个典型的getAvailabilities接口，接口连接在这里。
我们暂且就称为接口A。接口 A 通过参数获取可用房间和时间，所有可选参数如下所示：

{
    "checkIn": "20151001",
    "lastNight": "20151002",
    "checkOut": "20151003",
    "roomId": "12345",
    "propId": "1234",
    "ownerId": "123",
    "numAdult": "2",
    "numChild": "0",
    "offerId": "1",
    "voucherCode": "",
    "referer": "",
    "agent": "",
    "ignoreAvail": false,
    "propIds": [
        1235,
        1236
    ],
    "roomIds": [
        12347,
        12348,
        12349
    ]
}