RESTful 接口设计

接口设计原则

  1. 使用复数单词定义资源, 如下:
  • api.example.com/users/ 获取所有用户

  • api.example.com/users/{id} 获取id为参数值的用户

  1. URL中的多个单词用减号(-)分隔,

  2. URL中的单词字母[全小写], 非常特殊必要的情况才可以大写(如: URL中的参数变量)

  3. 请求参数名[全小写], 多个单词用下划线分割(_)

  4. 返回值为JSON格式, key的单词全小写, 多个单词用下划线分割(_)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容