RESTful接口规范

REST: 一种API风格

重要几点规范

域名/api路径

  • 尽量简单
    example.com/api
    api.example.com 有跨域问题

版本

  • 路径中
    api/1
  • headers中

路径

  • 名词

几种方法

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

搜索

get方法参数

  • limit
  • offset
  • page
  • per_page
  • sortby
  • order
  • pk

状态码与Code

错误处理

返回结果

Hypermedia API


Django Rest Framework

文章作者: Shoor
文章链接: https://shoorday.github.io/posts/8a3e1f41/
版权声明: 本博客所有文章除特别声明外,均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来自 Shoor's Blog