@@ -101,11 +101,23 @@ will point to the job queue resource. You can fetch the job queue resource perio
101101the type of the returned resource. Once the operation is complete, the request will return the created resource.
102102
103103# Server
104- The server included in this package is still under development. It is not suitable for real production environment yet
104+ The server included in this package is still under development. It is not yet suitable for real production environment
105105except maybe for really simple demo or testing cases.
106106
107107## URL Design
108- ##
108+ The URL Design specifies the structure of the URLs used for specific targets. The JSON: API standard describes 4
109+ possible request targets:
110+ - Collections (parameterized by the resource type)
111+ - Individual resources (parameterized by the resource type and id)
112+ - Related resources and collections (parameterized by the resource type, resource id and the relation name)
113+ - Relationships (parameterized by the resource type, resource id and the relation name)
114+
115+ The [ URLBuilder] builds those 4 kinds of URLs by the given parameters. The [ TargetMatcher] does the opposite,
116+ it determines the target of the given URL (if possible). Together they form the [ UrlDesign] .
117+
118+ This package provides one built-in implementation of [ UrlDesign] which is called [ PathBasedUrlDesign] .
119+ The [ PathBasedUrlDesign] implements the [ Recommended URL Design] allowing you to specify the a common prefix
120+ for all your JSON: API endpoints.
109121
110122
111123[ Response ] : https://pub.dartlang.org/documentation/json_api/latest/json_api/Response-class.html
@@ -121,6 +133,11 @@ except maybe for really simple demo or testing cases.
121133[ Response.asyncData ] : https://pub.dartlang.org/documentation/json_api/latest/json_api/Response/asyncData.html
122134[ PrimaryData.included ] : https://pub.dev/documentation/json_api/latest/document/PrimaryData/included.html
123135[ Document.errors ] : https://pub.dev/documentation/json_api/latest/document/Document/errors.html
136+ [ URLBuilder ] : https://pub.dev/documentation/json_api/latest/url_design/UrlBuilder-class.html
137+ [ TargetMatcher ] : https://pub.dev/documentation/json_api/latest/url_design/TargetMatcher-class.html
138+ [ UrlDesign ] : https://pub.dev/documentation/json_api/latest/url_design/UrlDesign-class.html
139+ [ PathBasedUrlDesign ] : https://pub.dev/documentation/json_api/latest/url_design/PathBasedUrlDesign-class.html
124140
125141[ Asynchronous Processing ] : https://jsonapi.org/recommendations/#asynchronous-processing
126- [ Compound Documents ] : https://jsonapi.org/format/#document-compound-documents
142+ [ Compound Documents ] : https://jsonapi.org/format/#document-compound-documents
143+ [ Recommended URL Design ] : https://jsonapi.org/recommendations/#urls
0 commit comments