【问题标题】:Designing a generic Rest API设计一个通用的 Rest API
【发布时间】:2014-11-19 18:35:12
【问题描述】:

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

我以矩阵的形式存储数据,“rest api”允许各种数据转换

例如 1. 对一行应用数学函数 2. 在列上应用数学函数 3.删除行 4.删除列 5.添加行 6.添加栏目 7. 如果缺少值,则删除行 ---- 以此类推

有人可以建议我命名其余 api 的正确方法吗?我应该为每个人去一个休息 api 吗?如果是,GET/POST/DELETE/PUT 的 url 会是什么样子?

如果你能指出一个例子会很有帮助

【问题讨论】:

    标签: django api rest django-rest-framework


    【解决方案1】:

    为了,

    1. 对一行应用数学函数
    2. 在列上应用数学函数

    以上这些应该采用/api/v1/(?P<type>(row|column))/(?P<id>\d+)/math_function/(?P<math_function_name>\w+)$的URL形式 这些也应该只尊重“PUT 或 PATCH”,因为如果我们遵循 RESTful 设计,我们只是希望使用来自数学函数的数据更新行或列。 math_function 在技术上是行或列的子集合,因此它位于 URL 结构中的最后。


    为了,

    1. 删除行
    2. 删除列
    3. 添加行
    4. 添加列

    以上这些应该采用/api/v1/(?P<type>(row|column))/(?P<id>\d+)/$的URL形式 这些也应该只尊重“POST 或 DELETE”,因为根据业务逻辑的唯一操作是删除或添加。


    为了,

    1. 如果缺少值则删除行

    这应该采用/api/v1/(?P<type>(row|column))/(?P<id>\d+)/conditional/(?P<condition_name>\w+)/$ 的URL 形式 上面的端点应该只尊重'DELETE',因为我们只会在这里删除行。


    上面是用/api/version/collection/id/subcollection/subid/的RESTful API设计写的

    【讨论】:

    • 数学函数是否建议将其添加到 url 中?我想,它必须作为参数的一部分发送。
    • /api/v1/(?P(row|column))/(?P\d+)/math_function/(?P\w+)$ 'math_function_name ' 正在捕获您要运行的数学函数的名称,这将需要您的视图中的一些逻辑来处理每个 math_function_name
    • 是的。那是真实的。但是,如果我有 20 个数学函数,最好将数学函数发送到参数列表中
    • 那么会有一个用例,您需要在给定时间运行 N 个数学函数?
    猜你喜欢
    • 1970-01-01
    • 2017-04-27
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2021-09-01
    • 2020-09-18
    • 2015-07-24
    相关资源
    最近更新 更多