REST API中的URI是什么

URI（Uniform Resource Identifier，统一资源标识符）是用于唯一标识互联网上的资源的字符串。在REST（Representational State Transfer，表征状态转移）架构中，URI被用作资源的唯一标识。在RESTful API中，URI定义了API的访问端点。

URI的格式

URI由以下几部分组成：

scheme://host:port/path?query#fragment

其中：

• scheme：协议，常见协议有http、https、ftp等；
• host：主机名或IP地址，标识资源所在的服务器；
• port：端口号，标识访问该服务器上的哪个服务；
• path：路径，标识资源在服务器上的位置；
• query：查询参数，用于向服务器传递参数；
• fragment：片段，用于标识资源中的特定部分。

RESTful API中的URI通常采用以下格式：

http(s)://host:port/path?query

其中，path和query部分是API的具体定义。

URI的设计原则

为了使API易于理解和使用，URI应当遵循以下原则：

• 使用名词而非动词。URI应当标识资源，而不是操作；
• 使用复数形式。URI中的实体名称应当使用复数形式，表示该资源可能包含多个实例；
• 使用有意义的名称。对于资源和其属性，URI应当使用具有描述性的名称；
• 避免使用难以理解的名称。避免使用缩写、无意义的数字或单词，以免造成混淆；
• 使用连字符。在URI中使用连字符而非下划线，以提高可读性；
• 避免使用大小写敏感的URI。URI应当忽略大小写，以避免资源无法被访问；
• 避免使用特殊字符。URI应当避免使用特殊字符，如$, @, +, /, #等。

URI的示例代码

以下是一个RESTful API中的URI示例代码：

https://api.example.com/v1/users?page=2&limit=10

其中：

• API版本为v1；
• 资源为用户（users）；
• 查询参数为page（页码）和limit（每页数据量）。

以上就是REST API中URI的介绍，使用合理的URI能够让API更易于使用和理解。