Q
Manage Learn to apply best practices and optimize your operations.

How should enterprises conduct an API assessment?

Before deploying a communications API, organizations must carefully assess their options. Learn about two red flags that could indicate poor API design.

A well-designed API is thoroughly documented in a way that's easy to understand.

When making an API assessment, two things can indicate bad design: Developers assume the code speaks for itself and don't take the time to explain their API.

Some people think great API code explains itself, but self-explanatory code is a myth. A developer should not assume the API design is so intuitive that documentation is unnecessary. If this assumption is made, organizations need to heed this red flag when making an API assessment.

If developers don't take the time to document the API they have created, then they probably haven't designed the API properly.

Great API design requires time and attention. The developer building the API needs to think about who will be using it and the different use cases.

A developer should take time to document and explain the API so its use becomes clear in an API assessment. The documentation should be an overview that encompasses the rationale behind the design, and it should include a reference guide that details the API's functions and the various edge cases it was built to handle.

The documentation should be the first thing to look at in an API assessment. If the documentation is easy to understand and explains how to use the API, that's the best sign for a great design. If the API is lacking documentation, it will be a red flag to potential poor API design.

Do you have a question for Tsahi Levent-Levi or any other experts? Ask your enterprise-specific questions today! (All questions are treated anonymously.)

Next Steps

API integrations require thorough planning

How to evaluate vendor APIs

An expert's advice for API design

This was last published in January 2017

Dig Deeper on Unified Communications Architecture and Service Models

PRO+

Content

Find more PRO+ content and other member only offers, here.

Have a question for an expert?

Please add a title for your question

Get answers from a TechTarget expert on whatever's puzzling you.

You will be able to add details on the next page.

Join the conversation

1 comment

Send me notifications when other members comment.

By submitting you agree to receive email from TechTarget and its partners. If you reside outside of the United States, you consent to having your personal data transferred to and processed in the United States. Privacy

Please create a username to comment.

What other red flags could indicate poor API design?
Cancel

-ADS BY GOOGLE

SearchCRM

SearchNetworking

SearchTelecom

SearchITChannel

Close