froilan's blog

Activity 34: Test API in POSTMAN

froilan's photo
froilan
·

2 min read

When working with APIs, especially those with numerous endpoints, it can become cumbersome to sift through a long, disorganized list of requests. Grouping related endpoints into subfolders in Postman introduces a layer of structure that makes it easier for developers and team members to understand and use the API effectively.

Key Benefits:

  1. Improved Readability: Subfolders create a visually structured hierarchy. For instance, if your API has endpoints for User Management, Authentication, and Product Management, each of these can be assigned to its own subfolder. This separation helps users quickly locate relevant endpoints without confusion.

  2. Logical Grouping: Grouping related requests together (e.g., all CRUD operations for a specific resource) mirrors the modular structure of the API itself. For example:

    • A User folder could contain subfolders like:

      • User Login

      • User Profile

      • User Preferences This mirrors the logical grouping often present in API documentation.

  3. Streamlined Documentation: When endpoints are organized systematically, documenting them becomes more intuitive. It is clear which endpoints are interrelated and belong to specific functionalities. This reduces errors and inconsistencies in the documentation.

  4. Enhanced Collaboration: Teams working on APIs will find it easier to onboard new members and maintain consistency in request management when a clear structure is already established.

Application in Postman:

In Postman, folders and subfolders serve as containers for API requests. By categorizing these requests:

  • You can label folders descriptively (e.g., Authentication, Orders, Payments) to highlight their purpose.

  • Nested subfolders allow you to further refine the organization by dividing a large module into smaller segments.

For instance:

Main Folder: E-Commerce API
├── Subfolder: Authentication
│   ├── Request: Login
│   ├── Request: Logout
│   └── Request: Refresh Token
├── Subfolder: Products
│   ├── Request: Get All Products
│   ├── Request: Add Product
│   └── Request: Delete Product

This hierarchy is particularly beneficial for teams using Postman Collections to share APIs across projects, ensuring the documentation remains straightforward and aligned with the API's structure.

Postman