DEV Community

Lars-Erik Bruce
Lars-Erik Bruce

Posted on

Name your APIs carefully!

The content of thoughts are words and concepts. The more precise your vocabulary is, the more precise are your thoughts.

Misleading or wrong names on fields, variable names, endpoints, will make your thoughts about your own code less precise. This is the most important in APIs meant to be consumed by several programmers.

If you find that something in your API could be named more precise, I find that it will be better for all parts if you deprecate this at once, and introduce the more precise name.

Top comments (0)