本文由 ChatMoney团队出品

一、URI范例

URI整个使用小写字母；使用中划线（-）分隔单词，而不是下划线（_）；对参数列表进行编码；URI中的名词应使用复数式样，代表资源蚁合；网址中只可包含名词，不成有动词，罕见情况之外。名词经常与数据库的表格名对应。

资源蚁合与单个资源：

URI不错暗示资源蚁合或单个资源。举例：

资源蚁合：/zoos（所有动物园），/zoos/1/animals（id为1的动物园中所有动物）单个资源：/zoos/1（id为1的动物园）

幸免层级过深的URI：

幸免使用过多的层级，举例GET /zoos/1/areas/3/animals/4。不错使用查询参数代替旅途中的实体导航，举例GET /animals?zoo=1&area=3。

二、版块

将API的版块号放入URI中，举例：

https://api.example.com/v1/zoos

三、Request

HTTP式样：

据CNMO了解，消费者对于智能投影的偏好正在发生变化。奥维云网（AVC）消费者调研数据显示，2020年出于尝鲜心理购买智能投影产品的因素占比为27%，但到2024年占比仅为12%。分析指出，消费者更注重产品的实际使用体验，如营造的氛围、大屏幕观影体验和技术进步带来的智能化等。另一个“坏消息”是，消费者对于智能投影产品的使用频率为“低频使用”的用户占比达到54%。

GET：查询资源，幂等；POST：创建新资源，非幂等；PUT：更新单个资源，幂等；DELETE：删除资源，幂等；HEAD：取得资源的元数据；OPTIONS：取得对于资源的信息；PATCH：更新资源的部分字段，幂等。

复杂查询：

不错使用以下参数进行复杂查询：

过滤要求：举例?chk=1&type=1&age=16；排序：举例?sort=age&order=asc；投影：举例?whitelist=id,name,email；分页：举例?page=2&per_page=100。

现象码：

作事器向用户复返的现象码和提醒信息，举例200 OK（GET央求到手），201 CREATED（POST/PUT/PATCH央求到手创建资源）等。

URI失效：

对于失效的API，复返404 Not Found或410 Gone；对于移动的API，复返301重定向。

四、Response

不要在反应体中进行包装；凭证不同的HTTP式样，到手处置后的数据式样分辨为：GET（单个对象/蚁合），POST（新增到手的对象），PUT/PATCH（更新到手的对象），DELETE（空）。

五、造作处置

发生造作时，不要复返2xx反应码；正确建立HTTP现象码，不要自界说；复返造作信息时，使用“error”手脚键名，造作样子手脚键值。

六、其他

API的身份认证应使用OAuth 2.0框架；作事器复返的数据式样应尽量使用JSON，幸免使用XML；对于复杂的接口，凭证业务代码详情使用POST还是PUT。要是接口产生的恶果幂等，使用PUT，不然使用POST。

对于咱们

本文由ChatMoney团队出品，ChatMoney专注于AI应用落地与变现，咱们提供全套、执续更新的AI源码系统与可施行的变现决策，辛苦于匡助更多东说念主欺诈AI来变现，接待投入

ChatMoney

取得更多AI变现决策！ManBetX官网在线登录