接口设计的一些总结

最新推荐文章于 2024-06-28 10:36:49 发布

cookedsteak

最新推荐文章于 2024-06-28 10:36:49 发布

阅读量427

点赞数 1

本文链接：https://blog.csdn.net/cookedsteak/article/details/90691028

版权

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

摘要由CSDN通过智能技术生成

接口是计算机通信的一种抽象概念，实现接口的方式有很多种，下面我们就基于 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
    ]
}

我们就来细细评鉴一下这个参数中有哪些不合理的地方。

1.日期

我们可以看到，在请求报文中，checkIn，lastnight，checkOut，都使用了黏在一起的年月日形式，YYYYMMDD，虽然这种形式的可读性也不差，但是对于跨语言解析的便利性上就不好说了。
其实作为时间，用 ISO8601 (Y

最低0.47元/天解锁文章

cookedsteak

关注

1
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
接口设计的一些总结

接口是计算机通信的一种抽象概念，实现接口的方式有很多种，下面我们就基于 http/https 的接口进行讨论api接口请求与返回参考How NOT to design APIs进行总结作者的朋友的项目正在使用Beds24这套系统，这套系统主要就是用来做预定的，连接的是Booking\AirBnB上的房源信息。而这个项目的功能就是从一些订房平台上获取可供预定的房间和日期。...
复制链接

扫一扫