排序字段设计_实战指南：10个有关RESTful API良好设计的最佳实践

最新推荐文章于 2023-06-03 11:05:04 发布
最新推荐文章于 2023-06-03 11:05:04 发布
阅读量458 收藏
点赞数
文章标签： 排序字段设计
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_39518840/article/details/111372133
版权

作者：JDON

链接：https://www.jdon.com/soa/10-best-practices-for-better-restful-api.html

Web API已经在最近几年变成重要的话题，一个干净的API设计对于后端系统是非常重要的。

　　通常我们为Web API使用RESTful设计，REST概念分离了API结构和逻辑资源，通过Http方法GET, DELETE, POST 和 PUT来操作资源。

　　下面是进行RESTful Web API十个最佳实践，能为你提供一个良好的API设计风格。

d61bc891c99681212436984000a46d20.png

1.使用名词而不是动词

726b61db5de06b3249b1b16e58b6b222.png

不要使用：

/getAllCars
/createNewCar
/deleteAllRedCars

2.Get方法和查询参数不应该涉及状态改变

使用PUT, POST

最低0.47元/天 解锁文章
weixin_39518840
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
RestfulQueries：一种在REST API上添加过滤，分页，排序，搜索的简便方法
02-04
宁静查询 通过支持分页，过滤，选择，排序和搜索来开发真正的静态API。 该项目可帮助您轻松地将这些功能添加到REST Controller中，而无需开发自定义解决方案。 该项目目前仅与Spring Data MongoDB应用程序兼容。 这里有一篇博客文章，我其中逐步描述了该库的实现。 入门 对于基于Maven的项目，将以下内容添加到pom.xml文件中。 可从Maven Central存储库中获得此​​依赖关系。 < dependency> < groupId>com.github.apavlidi</ groupId> < artifactId>restfulQ
RESTfulAPI设计最佳实践
02-03
目前互联网上充斥着大量的关于RESTfulAPI（为了方便，以后API和RESTfulAPI一个意思）如何设计的文章，然而却没有一个”万能“的设计标准：如何鉴权？API格式如何？你的API是否应该加入版本信息？目前互联网上充斥着...
RESTful之排序
IT之一小佬的博客
07-19 546
对于列表数据，REST framework提供了OrderingFilter过滤器来帮助我们快速指明数据按照指定字段进行排序。 使用方法： 在类视图中设置filter_backends，使用rest_framework.filters.OrderingFilter过滤器，REST framework会在请求的查询字符串参数中检查是否包含了ordering参数，如果包含了ordering参数，则按照ordering参数指明的排序字段对数据集进行排序。 前端可以传递的ordering参数的可选字段值需要在
javaapi中的排序
djfiew7234的博客
06-29 140
有的时候需要对数组里的element进行排序。当然可以自己编写合适的排序方法，但既然java包里有自带的Arrays.sort排序方法，在 数组元素比较少的时候为何不用？ 　　Sorting an Array 1. 数字排序 int[] intArray = new int[] { 4, 1, 3, -23 }; 　　Arrays.sort(intArray); 　　输出： [-...
从API角度彻底理解冒泡排序、选择排序、插入排序
LIUHAO的博客
04-11 737
从API角度彻底理解冒泡排序、选择排序、插入排序 Comparable接口介绍 冒泡排序 冒泡排序API设计： 冒泡排序的时间复杂度分析 选择排序 选择排序API设计： 选择排序的时间复杂度分析 插入排序 插入排序API设计 插入排序的时间复杂度分析
选择排序(api)实现
sy_white的博客
12-30 250
选择排序(api)
os_apidocs:用于OpenScholar的RestFul API文档
05-16
script src =" dist/os_apidocs.min.js " > </ script > < script > jQuery ( function ( $ ) { $ . awesome ( ) ; // "awesome" } ) ; </ script > 文献资料 （即将推出） 例子 （即将推出...
saltshaker_api：saltshaker_plus Restful API
02-05
此项目为Saltshaker的Restful API，需要结合前端项目 。架构图仪表板指导手册要求Python> = 3.6 Mysql> = 5.7.8（支持Json的Mysql都可以） Redis（无版本要求） RabbitMQ（无版本要求） Python黑人见requirements....
yet_another_pixel_draw：一个带有RESTful API的简单像素抽屉
02-05
一个带有RESTful API的简单SPA像素抽屉，作为前端进行响应，而django作为后端进行响应。 要求 Django的 Django Rest框架 频道 麻木 枕头 node.js和npm（构建前端） Redis /泊坞窗Redis 安装 作为其他存储的一部分...
DRF排序
weixin_44870612的博客
12-18 636
排序 对于列表数据，REST framework提供了OrderingFilter过滤器来帮助我们快速指明数据按照指定字段进行排序。 使用方法： 在类视图中设置filter_backends, 使用 rest_framework.filters.OrderingFilter 过滤器，REST framework会在请求的查询字符串参数中检查是否包含了ordering参数，如果包含了ordering参数，则按照ordering参数指明的排序字段对数据集进行排序。 前端可以传递的ordering参数的可选字段值
Java接口实现排序
benxiangsj的博客
03-16 1054
介绍了利用接口实现比较
搜索接口-排序（Search API-sort）
F7ANTY的专栏
10-20 1649
允许添加一个或多个排序到具体的某个字段。以及每个排序是可以逆转的。排序是定义在字段级别上的，通过_score字段，按得分排序。 { "sort" : [ { "post_date" : {"order" : "asc"} }, "user", { "name" : "desc" }, { "age" : "desc" },
自定义排序接口
刘炫320的博客
09-04 1245
我们习惯使用的Array和List类有时候经常需要使用排序，但是通常我们的对象都不可能只是一个简单的类型，而是一个复杂的类型，那么如何按照要求来进行排序呢？ 当然Array.sort()和List.sort()大家肯定都会用了， 但是比如我现在有的是一个区分姓何名存储的人的姓名的对象呢？怎么按照姓排序，当姓相同时，然后按照名来排序呢？ 这就需要用到IComparable比较接口了，它会自动生成
38_javaWeb接口，多个排序字段，用户随机选一个
谦虚的兔子的博客
10-11 460
0.可排序字段：id,age,income   1.查询接口中，有一个orderBy参数   2.如果用户选择的age，那么就把orderBy参数的值设置成age   3.java中，伪代码如下（因为第4步中，我们会用$符号取值，在这里防止sql注入）： if(orderBy == "id"){     orderBy = "id"; }else if(orderBy == "a...
签名验证中常见的参数字典升序排序及拼接
小创果技术交流博客
07-19 1434
相信大家在开发过程中都遇到一些API请求的时候需要验证签名，并且还需要对参数名字典升序排序及拼接，或许真的有用户拿着一堆参数一个一个的比较排序吧，这里给大家讲讲JS中比较常规的排序和拼接。如果有熟悉php的用户应该会知道ksort方法，js是没有这个方法的，但是我们可以自己封装一个，比较简单
一个多功能(聚合)查询接口，实现模糊、分页、主键、排序以及多条件查询
Jan's的博客
06-03 1762
写的啰嗦了点，看效果请直接忽略中间，直接看后半部分。小简聊开发。
Django Restful（DRF）框架学习（四）搜索、分页、排序
chinaltx的博客
02-08 2625
一、分页 在实际开发中不可能直接把一个视图下的全部数据一次性发送出去。 1.1 全局分页 在settings.py下配置即可设置全局分页的功能：为REST_FRAMEWORK字典加上'DEFAULT_PAGINATION_CLASS':'rest_framework.pagination.PageNumberPagination'。 PageNumberPagination类中有许多属性可以自己...
ElasticSearch排序查询数据restful api以及java代码实现
飞上云端看彩虹
05-01 6202
elasticsearch排序查询数据restful api以及java代码实现 restful api实现如下： post:http://192.168.1.111:9200/film/dongzuo/_search/ {   "sort":[      {"publishDate":{"order":"desc"}}   ] 根据发布日期降序排列； Java代码实现： ...
restful风格
热门推荐
刘超军的博客
08-24 13万+
概念 一种软件架构风格、设计风格，而不是标准，只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁，更有层次，更易于实现缓存等机制。 URL定义 资源：互联网所有的事物都可以被抽象为资源 资源操作：使用POST、DELETE、PUT、GET，使用不同方法对资源进行操作。 分别对应 添加、 删除、修改、查询。 ...
thinkphp6 route::resource restful api
最新发布
09-01
thinkphp6中的route::resource功能可以用于创建RESTful API。 RESTful API是一种用于构建Web服务的架构风格，它使用HTTP协议中的不同方法（GET、POST、PUT、DELETE等）来执行不同的操作。这意味着我们可以使用相同...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值