Restful Api接口规范

最近换了一家新公司,新公司用微服务架构开发,要求接口都用Restful规范,获取简单资源一般都好定义,例如:一个申请接口 url是 /applications,增删改查,用post,delete,put,get方法,但是其他的接口命名一直找不到合适的命名方法,所以特意搜索总结了一些,供大家参考指正:

用名词代替动词表示资源
GET /employees
GET /employees?state=external
POST /employees
PUT /employees/56

对可选的、复杂的参数,使用查询字符串(?)。
GET /employees?state=internal&maturity=senior

非资源请求用动词
有时API调用并不涉及资源(如计算,翻译或转换)。例:
GET /translate?from=de_DE&to=en_US&text=Hallo
GET /calculate?para2=23&para2=432

考虑特定资源搜索和跨资源搜索
提供对特定资源的搜索很容易。只需使用相应的资源集合URL,并将搜索字符串附加到查询参数中即可。
GET /search?query=Paul //返回 employees, customers, suppliers 等等.





  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值