restful-url相关内容

连字符、下划线或驼峰式大小写作为 URI 中的单词分隔符?

我正在为 Intranet 应用设计基于 HTTP 的 API.我意识到从整体上看这是一个很小的问题,但是:我应该使用连字符、下划线或驼峰命名法来分隔 URI 中的单词吗? 这是我的初步想法: 驼峰式 如果服务器不区分大小写,可能会出现问题 似乎在查询字符串键(http://api.example.com?**searchQuery**=...),但不在其他 URI 部分 ..
发布时间:2021-12-08 22:54:17 其他开发

我什么时候在 RESTful API 中使用路径参数和查询参数?

我想让我的 RESTful API 非常可预测.决定何时使用 URI 而不是使用查询参数对数据进行分段的最佳做法是什么. 支持分页、排序和分组的系统参数在“?"之后对我来说很有意义.但是,诸如“状态"和“地区"之类的字段或对您的集合进行细分的其他属性呢?如果这些也是查询参数,那么知道何时使用路径参数的经验法则是什么? 解决方案 RESTful API 设计的最佳实践是使用路径参数来标 ..

用于从子资源列表中更新/添加/删除项目的 REST 设计

当您拥有包含子资源列表的资源时,我想知道哪种最佳实践.例如,您有资源 Author,其中包含姓名、ID、生日和列表书籍等信息.此书单仅与作者有关​​.因此,您有以下场景: 您想在图书列表中添加一本新书 您想更新列表中的书名 您想从列表中删除一本书 解决方案 1 我搜索了正确的设计,并找到了多种方法.我想知道是否有设计这个的标准方法.我认为书中的设计说有以下方法: 添加: ..
发布时间:2021-11-15 21:03:03 其他开发

什么是使用逻辑操作进行查询的 RESTful 方式?

这是使用过滤器查询 假设我的应用程序正在管理称为工作负载的对象,其中包含以下字段.我想公开一个 REST 接口供用户通过标签查询工作负载. "Workload": {"id":"test1", "labels":["A", "B", "C"]}“工作负载":{“id":“test2",“标签":[“A",“C",“D"]}“工作负载":{“id":“test3",“标签":[“A",“B" ..
发布时间:2021-11-15 21:01:44 其他开发

一个 API 端点是否基于用户凭据 RESTful 和良好的 URI 设计来区分要返回的资源?

重要提示 这个问题的重点是 API 端点,它区分哪些资源返回取决于谁进行身份验证,例如Alice 得到资源 A 和 B 返回,Bob 得到资源 X 和 Y. 它不是区分返回资源的表示. 所有端点都返回资源的 JSON 表示. 前言 请考虑以下三个潜在的 API 端点设计,它们都返回用户的 thing 资源. 端点 A GET/things 如果 的身份验证凭 ..
发布时间:2021-11-15 21:00:23 其他开发

RESTful API 路由设计:嵌套与非嵌套

我的问题是关于为 API 目的构建 URL 时嵌套资源的优势.考虑以下两种访问员工资源的方法: /api/employees?department=1 # flat对比/api/departments/1/employees # 嵌套 现在考虑开发通用库以从 API 访问 REST 资源的任务.如果所有路由都是扁平的,那么这样的 REST 包装器库只需要知道被访问的资源的名称: store. ..

什么时候在 RESTful API 中使用路径参数和查询参数?

我想让我的 RESTful API 非常可预测.决定何时使用 URI 而不是使用查询参数对数据进行分段的最佳做法是什么. 支持分页、排序和分组的系统参数在“?"之后对我来说很有意义.但是,诸如“状态"和“地区"之类的字段或对您的集合进行细分的其他属性呢?如果这些也是查询参数,那么知道何时使用路径参数的经验法则是什么? 解决方案 RESTful API 设计的最佳实践是使用路径参数来标 ..

在 RESTful URL 中使用动词和形容词的替代方法

我想向我的 REST API 添加操作,以便在不同的“商店"之间移动“资源". 例如,假设我的资源通常通过以下 URL 访问: /resources/resources/{resourceId} 现在假设我想“停用"某些资源,即从概念上将其移动到另一个子文件夹.允许这样做的最直接方法如下. “停用"资源,即使其在/resources 下不可用.从概念上讲,它将对象“移动"到“/re ..
发布时间:2021-11-15 02:35:53 其他开发

RESTful URL 设计:公共与私有 API、层次化 API 设计模式、URI 与 URL 设计?

我经常遇到这样的问题,非常类似于Hierarchical RESTful URL design 假设该服务仅提供用户上传文档. POST, GET/accountsPUT、DELETE/accounts/{name} 或/accounts/{id} 现在一个文档被附加到一个特定的用户,它是否是公开的,这里根本不关心. 两种方式是POST/documents vs POST/user ..
发布时间:2021-11-15 02:28:36 其他开发

REST API URL 必须像这样吗?

实现 RESTful API 是不是必须实现一个像这样的 URL 结构 http://example.com/post/http://example.com/post/123 /123 将用于编辑、删除 另一种提问方式是:像这样的 URL 可以称为 RESTful 吗? http://example.com/script.php?method=get_title&blogid=123 ..
发布时间:2021-11-15 01:54:21 其他开发

如何构建 REST 资源层次结构?

我是服务器端 Web 开发的新手,最近我阅读了很多关于实现 RESTful API 的文章.我仍然坚持的 REST API 的一个方面是如何构建标识客户端可以与之交互的资源的 URI 层次结构.具体来说,我一直在决定制作层次结构的详细程度以及在资源由其他资源类型组成的情况下该怎么做. 这里有一个例子,希望能说明我的意思.想象一下,我们有一个 Web 服务,可以让用户从其他用户那里购买产品.所 ..
发布时间:2021-11-15 01:50:49 其他开发

API 的 URL 设计

我正在为我们的后端开发私有 API. 我的收藏有关联. 可以对每个集合进行请求、分页,也可以请求关联并对这些关联进行分页. 我们不确定要使用哪种 URL 设计……我们正在考虑: /users.json?per_page=10&association=parts,auditions&parts_per_page=5&auditions_per_page=5 /users.jso ..
发布时间:2021-11-15 00:35:37 其他开发