Modules

What are Modules?

Modules are logical containers that group related endpoints together. Think of them as folders or categories within your project. A well-organized project might have modules like "Authentication", "Users", "Products", "Orders", etc.

Without Modules
GET /users
POST /users
GET /products
POST /orders
GET /auth/login
DELETE /users/:id

Flat, hard to navigate

With Modules
Users/
GET /users
POST /users
DELETE /users/:id
Products/
GET /products

Organized, easy to find

Creating a Module

1

Open Project Menu

Expand your project, then click the three-dot menu (⋮) next to the project name.

2

Select "Add Module"

Click the "Add Module" option in the dropdown menu.

3

Enter Module Name

In the dialog, enter a descriptive name for your module (e.g., "Users", "Authentication").

4

Module is Created

The new module appears under your project. It's initially empty - ready for endpoints.

Add Module
Servers
Environments
About
Rename
Delete

Module in Sidebar

Once created, modules appear under their project with a distinct icon:

Order API
Design Project
Users⋮

• Click the module name to expand/collapse its endpoints

• Hover to reveal the menu button (⋮)

• The arrow indicates expand/collapse state

Module Menu

Click the three-dot menu (⋮) on a module to access these actions:

Add Endpoint

Create a new endpoint within this module. See the "Endpoints" section for details.

Rename

Change the module name. The name becomes editable inline. Press Enter to save or Escape to cancel.

Delete

Delete the module and all its endpoints. A confirmation dialog appears. This action cannot be undone.

Add Endpoint
Rename
Delete

Module Naming Best Practices

Good Names
  • • Users
  • • Authentication
  • • Products
  • • Orders
  • • Payments
  • • Notifications
Avoid
  • • Module 1
  • • API
  • • Endpoints
  • • Misc
  • • Other
  • • Stuff

Tip: Name modules after the resource or domain they represent. Use plural nouns (Users, not User) for consistency.

Create ProjectEndpoints