Over a million developers have joined DZone.
{{announcement.body}}
{{announcement.title}}

Reducing Friction for API Developers With Enums in API Definitions

DZone's Guide to

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.

· Integration Zone
Free Resource

Share, secure, distribute, control, and monetize your APIs with the platform built with performance, time-to-value, and growth in mind. Free 90-day trial of 3Scale by Red Hat

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.

Explore the core elements of owning an API strategy and best practices for effective API programs. Download the API Owner's Manual, brought to you by 3Scale by Red Hat

Topics:
integration ,apis ,api resources

Published at DZone with permission of Kin Lane, DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

THE DZONE NEWSLETTER

Dev Resources & Solutions Straight to Your Inbox

Thanks for subscribing!

Awesome! Check your inbox to verify your email so you can start receiving the latest in tech news and resources.

X

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}