总论

新版API的基本设计原则和特点。

REST API

新版API很大程度上使用 RESTful API 规范，旨在使得调用和缓存更加清晰和可靠。但也可根据实际应用场景进行变通。

LrcAPI设计原则

• 无状态

  API是无状态的，即每个请求间没有上下文关联。请求只有对资源做出改变，才会影响到其他请求。

• 通过GET发起

  除非向资源提交内容，否则一律通过GET方法发起请求，原因是便于在Web端调试，在合理范围降低操作门槛。

• 可缓存

  LrcAPI响应内容是可缓存的，这意味着API端点应当具有固定的HTTP方法（通常是GET）、固定的路径（/api/v1/...）和查询参数。

• 资源响应

  原则上，首次响应应当为JSON，并通过Accept和Content-Type字段表示清晰。

• 状态码

  采用常用标准状态码（200/301/302/403/404/429）规范，更多自定义状态码请查阅文档 状态码

• 兼容性

  原则上，LrcAPI应保证向后兼容。