We are delighted to present our first web-exclusive pattern adoption story, contributed by our reader Ton Donker.
In the pattern story Dutch Government & Energy Sector, Ton shares some other well-known uses of the Wish List, Pagination, and Error Report patterns, as well as additional discussion points and recommended reading.
The Wish List pattern is widely used in Dutch government APIs. One implementation hint is to distinguish between different variants of Metadata Elements by prefixing them in the query string:
To distinguish between ‘real’ query parameters and the more ‘steering’ or ‘meta’ parameters like expand, fields, limit and page, we – the Dutch Energy sector API Working Group – advocate the usage of an underscore prefix, so _fields, _expand, _limit and _page to prevent misinterpretation of the function of the query parameters.
We are looking forward to more pattern adoption stories from the community. If you would like to share one, please contact us at info@microservice-api-patterns.org.