Reducing Friction for API Developers With Enums in API Definitions
Kin Lane believes that the work that the Oxford Dictionaries API team has put in will go a long way towards making their API resources more accessible and usable.
Join the DZone community and get the full member experience.Join For Free
I am going through the Oxford Dictionaries API and learning about this valuable resource. Their onboarding process for registration and what the API does using interactive documentation are very smooth. One of the things that really cuts the rough edges off learning about each API are the enums that are available for each path.
The parameters required for making calls to many of the paths, like language and country, have their enum values populated as part of their API definition. I look at numerous OpenAPI Specs in the course of my work and they rarely have values present for enum, providing critical default values for developers to use and eliminating some often serious frustration.
Not having the right values available when making even the simplest of API calls can be a significant point of friction when trying to get up and running using an API. While it may seem like a small thing, the work that the Oxford Dictionaries API team has put into this level of detail for their API definitions will go a long way towards making their API resources more accessible and usable.
Published at DZone with permission of Kin Lane, DZone MVB. See the original article here.
Opinions expressed by DZone contributors are their own.