๐Ÿ‘ Using Plain Language In Your API Paths

Liked Using Plain Language In Your API Paths (apievangelist.com)

There is no reason that your API paths shouldnโ€™t be plain language, using common words. Iโ€™m not even talking about good RESTful resource design, Iโ€™m simply talking about looking at the URI for an API and being able to understand what it is because it used words we can understand. If you have trouble pausing, and stepping back, and thinking what some random 3rd party developer will interpret your API paths as, I recommend printing them out and sharing them with someone that isnโ€™t on your team, and familiar with the resources you work with. Even if your APIs arenโ€™t going to be public, someday you will be gone, and maybe your documentation isnโ€™t up to date, and someone will have to reverse engineer what your API does. There is no reason your API should hide what it does, and not speak for itself, providing an intuitive, plain language description of the value it possesses.

Donโ€™t be part of the problem in the future. Speak in plain language, and make your API paths speak for themselves.

Leave a Reply

Your email address will not be published. Required fields are marked *