Constructing Searchable Resources
This example constructs a search form and searchable collection resource. Navigate to this resource from the home via the ‘tenants’ link relation. Then search back on the collection.
Goal
- Create searches/filters on collections
- Create cachable search forms
- Demonstrate one way to process a search form to redirect back on a filterable collection
Anatomy of search
| Method | link rel | associated route | notes |
|---|---|---|---|
| GET | / | start at the root of the api which has
tenants
as a link rel |
|
| GET | tenants |
/tenant/ | follow the
tenants
link to get the collection |
| GET | search |
/tenant/form/search | follow the
search
form to get fields to fill in (this creates a filter in the current implementation) |
| POST | submit |
/tenant/search/ | fill in the form and send back to
submit
URL. Response returns
201 Created
with
Location
header |
| GET | /tenant/?q= | follow the
Location
header returns a filtered search (feed) collection. Note: this is the same route as
tenants
link rel |
Note: by convention a form can be submitted semantically. The
submitlink rel is usually the first option but it could be back on the originating collection. In this case, because the tenant collection is logically parented on the root rather than on a user (which it probably should but this collection is a convenient collection).
Anatomy of code
Add tenants
Below, you see on overview of the code, then you see the implementation.
Return tenants collection (with search link)
Below, you see on overview of the code, then you see the implementation.
Search form
Below, you see on overview of the code, then you see the implementation.
Make the Search
The search here is a simple technique to redirect back to the collection that takes an optional filter.
Below, you see on overview of the code, then you see the implementation.