Resource naming conventions in Node.js

Introduction

Resource naming conventions help keep your code clear and easy to understand. They make it simple to find and use parts of your app.

When creating API endpoints for a web server

When naming files and folders in a project

When defining variables or constants that represent resources

When organizing routes in a Node.js application

When collaborating with others to keep code consistent

Syntax

Node.js

Use lowercase letters and hyphens for resource names.
Example: /users, /blog-posts

Use plural nouns for collections.
Example: /products, /orders

Use singular nouns for single items.
Example: /user/:id, /order/:id

Use hyphens (-) instead of underscores (_) or camelCase for URLs.

Keep names simple and descriptive.

Examples

Standard RESTful API routes for a 'users' resource.

Node.js

GET /users
GET /users/:id
POST /users
PUT /users/:id
DELETE /users/:id

Using hyphens for multi-word resource names.

Node.js

GET /blog-posts
GET /blog-posts/:postId

Variables naming resources in Node.js code.

Node.js

const userResource = '/users';
const singleUserResource = '/users/:id';

Sample Program

This Node.js Express app uses resource naming conventions for routes. '/books' is plural for the collection, and '/books/:id' is singular for a single book.

Node.js

import express from 'express';
const app = express();

// Resource naming follows conventions
app.get('/books', (req, res) => {
  res.send('List of books');
});

app.get('/books/:id', (req, res) => {
  res.send(`Book details for ID: ${req.params.id}`);
});

app.listen(3000, () => {
  console.log('Server running on http://localhost:3000');
});

Important Notes

Always use lowercase letters in URLs to avoid confusion.

Plural names help indicate collections of items.

Consistent naming makes your API easier to use and maintain.

Summary

Use lowercase and hyphens for resource names.

Use plural nouns for collections and singular for single items.

Keep names simple, clear, and consistent.