URI: Difference between revisions
| (5 intermediate revisions by the same user not shown) | |||
| Line 11: | Line 11: | ||
* [[URL]] | * [[URL]] | ||
* [[URN]] | * [[URN]] | ||
* [[Best Practices for Naming REST API | * [[Best Practices for Naming REST API URIs#Overview|Best Practices for Naming REST API URIs]] | ||
=Overview= | =Overview= | ||
| Line 17: | Line 17: | ||
A Uniform Resource Identifier (URI) is a compact sequence of characters that identifies an abstract or physical resource. An URI can be a [[URL]] or an [[URN]]. Every URL is a URI, abstractly speaking, but not every URI is a URL. | A Uniform Resource Identifier (URI) is a compact sequence of characters that identifies an abstract or physical resource. An URI can be a [[URL]] or an [[URN]]. Every URL is a URI, abstractly speaking, but not every URI is a URL. | ||
REST APIs use URIs to address resources. [[Best Practices for Naming REST API | REST APIs use URIs to address resources. [[Best Practices for Naming REST API URIs#Overview|Best Practices for Naming REST API URIs]] contains some rules to use when creating URIs for resources. | ||
Tim Berners-Lee: "The only thing you can use an identifier for is to refer to an object. When you are not dereferencing, you should not look at the contents of the URI string to gain information". This seems to advocate for URI opacity. However, REST API designers should create URIs that convey a REST API's resource model to its clients. | Tim Berners-Lee: "The only thing you can use an identifier for is to refer to an object. When you are not dereferencing, you should not look at the contents of the URI string to gain information". This seems to advocate for URI opacity. However, REST API designers should create URIs that convey a REST API's resource model to its clients. | ||
| Line 26: | Line 26: | ||
<font size=-1> | <font size=-1> | ||
scheme "://" authority "/" path [ "?" query ] [ "#" fragment ] | [[#Scheme|scheme]] "://" [[#Authority|authority]] "/" [[#Path|path]] [ "?" [[#Query|query]] ] [ "#" [[#Fragment|fragment]] ] | ||
</font> | </font> | ||
==Scheme== | |||
==Authority== | |||
Also see: {{Internal|Best_Practices_for_Naming_REST_API_URIs#Authority_Rules|REST API Authority Rules}} | |||
==Path== | |||
==Query== | |||
Also see: {{Internal|Best_Practices_for_Naming_REST_API_URIs#URI_Query_Rules|REST API Query Rules}} | |||
==Fragment== | |||
=URI Template= | |||
{{External|https://datatracker.ietf.org/doc/html/draft-gregorio-uritemplate}} | |||
Latest revision as of 23:34, 14 February 2024
External
- Uniform Resource Identifier (URI): Generic Syntax https://tools.ietf.org/html/rfc3986
- URI Template https://tools.ietf.org/html/rfc6570
- Format for Literal IPv6 Addresses in URLs http://www.ietf.org/rfc/rfc2732.txt
- https://danielmiessler.com/study/url-uri/
Internal
Overview
A Uniform Resource Identifier (URI) is a compact sequence of characters that identifies an abstract or physical resource. An URI can be a URL or an URN. Every URL is a URI, abstractly speaking, but not every URI is a URL.
REST APIs use URIs to address resources. Best Practices for Naming REST API URIs contains some rules to use when creating URIs for resources.
Tim Berners-Lee: "The only thing you can use an identifier for is to refer to an object. When you are not dereferencing, you should not look at the contents of the URI string to gain information". This seems to advocate for URI opacity. However, REST API designers should create URIs that convey a REST API's resource model to its clients.
Format
RFC 3986 defines the generic URI syntax:
scheme "://" authority "/" path [ "?" query ] [ "#" fragment ]
Scheme
Authority
Also see:
Path
Query
Also see: