Advices on Creating Web API

Publish the whole thing and make sure it is all well documented. Also, don’t hide functions through obscurity.

>> some types of customers don’t need to see all of the API in the library
Don’t try to go down that road. If you start hiding functions through obscurity, they will pop out anyway (through code samples, forums, reverse engineering, pentesting, etc.) and will only lead to bad things (developers pissed at you for “crappy, incomplete documentation,” customers laughing at you for “trying to hide the best stuff,” salespeople people yelling at you for not exposing something you’ve already written but they didn’t know they needed until they walked out of a customer meeting, top executives yelling at everyone when a security researcher finds a big flaw in a rarely used function call that everyone forgot about).

Signed,
Dude With 15 Years Experience With Web APIs
(Who Has Had Much Of This Happen To Him Or His Company)
xxxJonBoyxxx

Publish the whole thing and make sure it is all well documented.
When we evaluate products, one thing I always look for is a well documented API with full functionality.

Then endure your internal developers use it and eat their own dog food.
Anonymous Coward

Source:
Ask Slashdot: Best API Management System? | Slashdot

Advertisements

Tags: , , , ,

About Ferry T.H.

I'm just your fellow human being.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: