When naming your #API endpoint requests, it's important to follow best practices to ensure that your... Tagged with api, beginners, tutorial, programming.

Aishwary Gupta

Community Picks is a section on daily.dev where our community members share the most interesting and valuable content they've discovered online. From insightful articles to handy tools, every post is a gem curated by our dedicated coomunity. To contribute to Community Picks, you need to have at least 250 reputation points, ensuring that only active and trusted members can share their finds.

Community Picks

Following best practices for naming API endpoints ensures your API is intuitive, consistent, and easy to use. Use nouns for resource names, plural names for collections, and HTTP methods to define actions. Maintain a clear hierarchical structure, use consistent naming conventions, avoid special characters and spaces, keep names simple and intuitive, include versioning, and describe actions with query parameters.

Best Practices for Naming API Endpoints

<pre><code>/v1/orders/{id}/cancel
</code></pre>
<ol>
<li>
“Cancel” is a verb ❌ - Change it to a word that best describes the state of the resource post-operation. Suggestions: “Cancelled” if the status is Cancelled or “Cancellation” if you prefer an actual noun. ✅
</li>
<li>
POST is meant for creation of resource ❌ Use PATCH for partial updates ✅
</li>
</ol>
The rest are fine (no pun intended)
I think REST is good practice but calling it the “best practice” makes it dogmatic and it turns away people. REST is just one way to get the job done. So lets call it “REST practices”.

Using verbs like “cancel” is afaik an anti pattern. Instead I am using nouns like “cancellation” or plural if it is possible by Domain. Other ones would be “rejections”, “withdrawals”, “acceptances”. Simple get or post depends on the api Conventions. I am not sure if there is a best practice.

Versionning api is used a lot but have seen a lot of time not changed and stayed at v1 even with new api or major changes. Can’t understand why but at the end it’s overkilled like that.

“For a single resource, use the singular form along with its identifier (e.g., /users/{id}).”
Wait, “users” is singular?

Just name it in a confusing way , they always need you😂😂😂
Login endpoint: login
Logout endpoint : llogin
Get products : logiin
Add products : loggin
More confusing more money you earn 😂
Just kidding.