Use standard capitalization for acronyms in all identifiers, method names, variables, and other code elements. Common acronyms like 'API', 'URL', 'JSON', 'HTML', and 'XML' should be written in all uppercase letters.
Use standard capitalization for acronyms in all identifiers, method names, variables, and other code elements. Common acronyms like ‘API’, ‘URL’, ‘JSON’, ‘HTML’, and ‘XML’ should be written in all uppercase letters.
This applies to all contexts:
getAPIKeys
instead of getApiKeys
userAPIConfig
instead of userApiConfig
"name": "Get API Keys"
instead of "name": "Get Api Keys"
For example, in our API endpoint definitions:
{
"_type": "endpoint",
"name": "Get API Keys", // Correct - acronym fully capitalized
...
}
Instead of:
{
"_type": "endpoint",
"name": "Get Api Keys", // Incorrect - inconsistent acronym capitalization
...
}
Consistent acronym capitalization improves code readability, maintains professional standards across the codebase, and helps ensure interface consistency for users.
Enter the URL of a public GitHub repository