Sample .NET 5 Web API to manage a list of to do items.
This implementation satisfies all REST constraints as well as Richardson Maturity Model level 3, and provides examples of OPTIONS, HEAD, GET, POST, PUT, PATCH, and DELETE. All wirite methods also support "upserting".
In addition is uses proper identification of resources and methods, an outer facing contract, provides proper error responses (client errors vs. server faults), and contains self-discoverability.
- Filtering for specific keys in the outer facing contract
- Searching via a searchQuery parameter on the underlying data
- Sorting via an orderBy query parameter that maps outer facing contract properties to underlying data column(s)
- Paging via pageSize and pageNumber query parameters with information returned in an X-Pagaination header in the response
- Data Shaping via a fields query parameter that can be used on either the outer facing contract or underlying data
- HATEOAS support for both single items and collections via a custom vender media type in the request Accept header
- Content negotiation for outer facing data or underlying data via custom media type, with or without HATEOAS links
- Caching at the server level
- Compression support for both Gzip and Brotli