URL 规范 整理

URL 规范 整理

大家好,又见面了,我是全栈君。

URL 规范

  1. 不用大写;(强制)
  2. 用中杠-不用下杠_;(强制)
  3. 参数列表要encode,编码使用utf-8;(强制)
  4. URI中的名词表示资源集合,使用复数形式。(建议)
  5. 增加版本号(建议)

URI中统一使用小写字母

根据RFC3986定义,URI是对大小写敏感的,所以为了避免歧义,我们尽量用小写字符。但主机名(Host)和scheme(协议名称:http/ftp/…)对大小写是不敏感的。

URI中尽量使用连字符”-“代替下划线”_”的使用

连字符”-“一般用来分割URI中出现的字符串(单词),来提高URI的可读性,例如:
http://api.example.restapi.org/blogs/mark-masse/entries/this-is-my-first-post

使用下划线”_”来分割字符串(单词)可能会和链接的样式冲突重叠,而影响阅读性。但实际上,”-“和”_”对URL中字符串的分割语意上还是有些差异的:”-“分割的字符串(单词)一般各自都具有独立的含义,可参见上面的例子。而”_”一般用于对一个整体含义的字符串做了层级的分割,方便阅读,例如你想在URL中体现一个ip地址的信息:210_110_25_88 .

URL增加版本号

根据项目的更新,原来的URL可能被多个项目所使用,需要兼容原有系统的情况下,支持新业务。
提供给内部系统使用的api,建议使用`/api/v1/`开头, 提供给前端APP使用的api,建议使用`/web-api/v1/`开头

/api/v1/loan
/web-api/v1/loan

资源集合 vs 单个资源

URI表示资源的两种方式:资源集合、单个资源。

资源集合:

/zoos //所有动物园
/zoos/1/animals //id为1的动物园中的所有动物

单个资源:

/zoos/1 //id为1的动物园

 

避免层级过深的URI

/在url中表达层级,用于按实体关联关系进行对象导航,一般根据id导航。

过深的导航容易导致url膨胀,不易维护,如 GET /zoos/1/areas/3/animals/4,尽量使用查询参数代替路径中的实体导航,如GET /animals?zoo=1&area=3;

 

转载于:https://www.cnblogs.com/hduwbf/p/7300794.html

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

发布者:全栈程序员-用户IM,转载请注明出处:https://javaforall.cn/108262.html原文链接:https://javaforall.cn

【正版授权,激活自己账号】: Jetbrains全家桶Ide使用,1年售后保障,每天仅需1毛

【官方授权 正版激活】: 官方授权 正版激活 支持Jetbrains家族下所有IDE 使用个人JB账号...

(0)


相关推荐

  • IoU计算

    输入:vector<float>p1;//y1min,x1min,y1max,x1max;vector<float>p2;//y2min,x2min,y2max,x2max;输出:floatIoU代码:floatcomputeIoU(vector<float>p1,vector<float>p2){…

  • drupal教程 Drupal安装指南

    drupal教程 Drupal安装指南译者:老葛从开始学习Drupal到现在,安装的都是5.1,5.2的版本,由于使用的是wdp开发工具,所以安装基本上不需要做什么的,大概都是建立数据库名,修改一下settings.php配置文件,在浏览器里面敲入install.php,就可以自动完成安装了。所以说,drupal的安装是极其简单的,而且很容易上手。  但是由于客户的要求,需要使用drupal4.7的版本,由于用过5.1+的版

  • 如何telnet端口_telnet查看端口是否开放

    如何telnet端口_telnet查看端口是否开放cmd中,命令:talnetIP或域名端口号若提示:‘telnet’不是内部或外部命令,也不是可运行的程序或批处理文件。按次地址进行调整https://jingyan.baidu.com/article/3d69c551531986f0ce02d774.html转载于:https://www.cnblogs.com/mjbenkyo/p/8029535.html…

  • android 小米pad 调试,小米平板2 开启USB调试模式「建议收藏」

    android 小米pad 调试,小米平板2 开启USB调试模式「建议收藏」我们要将小米平板2与电脑进行连接,就必须要打开小米平板2系统的调试模式,不同的系统版本打开调试模式的方法有所不同,在这里我们就谈谈小米平板2各种系统版本打开USB调试模式的方法。1、针对Android2.1-2.2版本的系统:我们在桌面按小米平板2手机上的“菜单键”会弹出菜单,点击“设置”选项进入系统的设置菜单列表,然后进入“应用程序”—“开发”,就可以看到“USB调试”选项,我们勾选即可…

  • linux下压缩与解压缩-tar和zip_linux打包命令

    linux下压缩与解压缩-tar和zip_linux打包命令linux下tar和zip压缩效率图13总结:通过测试,在本次实验中我们得出的以下几点结论:1.小文件(最好是大于0.5M,如果文件太小,在进行tar打包并压缩或者zip压缩时,其占用的磁盘空间会比源文件大很多)在进行tar打包并压缩或者zip压缩时,其占用磁盘的大小不变;中等文件(100M左右的pdf格式文件),在进行tar打包并压缩或者zip压缩时时,大约节…

  • java finalize 作用_java中的finalize方法有什么作用「建议收藏」

    java finalize 作用_java中的finalize方法有什么作用「建议收藏」java中的finalize方法是Object类中提供的一个方法,在GC准备释放对象所占用的内存空间之前,它将首先调用finalize()方法。finalize()方法是Object类中提供的一个方法,在GC准备释放对象所占用的内存空间之前,它将首先调用finalize()方法。其在Object中定义如下:protectedvoidfinalize()throwsThrowable{}…

发表回复

您的电子邮箱地址不会被公开。

关注全栈程序员社区公众号