设计通用的Rest API

时间:2014-11-19 18:35:12

标签: django api rest django-rest-framework

我需要在django中设计一个rest api服务器。我很困惑如何命名其余的api

我已经以矩阵的形式存储了数据,并且已经存储了数据。允许各种数据转换

例如 1.在一行上应用数学函数 2.在列上应用数学函数 3.删除行 4.删除色谱柱 5.添加行 6.添加列 7.如果缺少值,则删除行 ----等等

有人可以建议我正确地命名其他api。我应该为每个人休息一次吗?如果是,那么对于GET / POST / DELETE / PUT,网址将如何?

如果你能指出一个例子

会很有帮助

1 个答案:

答案 0 :(得分:1)

有关,

  1. 在一行上应用数学函数
  2. 在列上应用数学函数
  3. 上述内容应采用/api/v1/(?P<type>(row|column))/(?P<id>\d+)/math_function/(?P<math_function_name>\w+)$的网址格式 这些也应该只尊重'PUT或PATCH',因为如果我们遵循RESTful设计,我们只想用数学函数中的数据更新行或列。 math_function在技术上是行或列的子集合,因此它是URL结构中的最后一个。


    有关,

    1. 删除行
    2. 删除列
    3. 添加行
    4. 添加列
    5. 上述内容应采用/api/v1/(?P<type>(row|column))/(?P<id>\d+)/$的网址格式 这些也应该只尊重'POST或DELETE',因为根据业务逻辑的唯一操作是删除或添加。


      有关,

      1. 如果缺少值,则删除行
      2. 这应采用/api/v1/(?P<type>(row|column))/(?P<id>\d+)/conditional/(?P<condition_name>\w+)/$的网址格式 上面的端点应该只考虑'DELETE',因为我们只会在这里删除行。


        以上内容是使用/api/version/collection/id/subcollection/subid/

        的RESTful API设计编写的