rest - 使用 RESTful API 访问配置设置？

Question

我正在设计一个前端来修改我正在开发的 Web 应用程序的设置。设置存储如下:

{
    "site_title": "My Web Site",
    "site_description_long": "Welcome to My Web Site! Lots of welcome text here!",
    "site_description_short": "It's my site"
}

我对 REST API 很陌生，所以我不确定如何继续。它不像所有其他资源，如用户和帖子，其中有许多对象。只有一个 Settings 对象具有无限数量的键和值。 /settings 是不是不好的做法？返回单个对象？按名称访问它并只返回像 /settings/site_title 这样的字符串是不好的做法吗？ ?当客户端可以缓存整个设置对象客户端时，这甚至是必要的吗？

Answer 1

一种选择是将每个设置视为其自己的资源。

GET /settings/
{
    settings: [
        { "id":"site_title" , "value":"My Web Site" },
        { "id":"site_description_short" , "value":"It's my site" },
    ]
}

GET /settings/site_title
{
    "id":"site_title", 
     "value":"My Web Site"
}

这种方法是 RESTful，但会导致大量服务器命中。我认为使用您描述的单个对象并非不合理，尽管如果您有 500 个设置，处理起来可能会很痛苦。