Postman Documentation Unified Access and Sharing

Everything the team needs to browse Postman Collections, run the site locally, and share ready-to-use links

Quick Start Download Core Collections

🚀 Access Methods

Choose the most suitable method to open the documentation site locally or while sharing with the team

Direct Open

Open `postman/docs/index.html` directly in the browser without any additional settings

open postman/docs/index.html

PHP Built-in

Run a lightweight PHP server to display the site

cd postman/docs && php -S localhost:8000

Python / Node

Quick alternatives using Python or http-server

python3 -m http.server 8000
http-server -p 8000

Production

After deployment use public `/docs/` link or host files on GitHub Pages

https://your-domain.com/docs/

🎨 Features

Ready-made interface with fast navigation and direct download support

Responsive Interface

Design that works on mobile and desktop with full RTL support

Easy Navigation

Sidebar, sticky header, and smooth scroll for quick access to sections

Comprehensive Documentation

Details for each endpoint with request/response and copyable examples

Download Links

Direct download for Collections classified by module and type

📍 Quick Start

Quick steps for developers and users to access documentation and start working immediately

1

Open Site

Use any of the access commands above or the link after deployment

http://localhost:8000
2

Choose Module

Browse the cards, then open the module page to read documentation and download the collection

3

Download & Import

Download the collection, then import it in Postman and add variables (base_url, token, location_id)

🔗 Quick Sharing

Ready templates for email or Slack/Teams to share documentation link with the team

Email Template

Subject: Flexo-HMS API Docs Ready

Hi Team,

Docs are live at http://localhost:8000 (or your production URL).
- All modules documented
- Collections ready to download
- Examples for each endpoint

Steps: open the link → pick a module → download collection → import into Postman → set env vars.

Thanks!

Slack / Teams

📚 Flexo-HMS API Docs live!
Link: http://localhost:8000
Includes: modules overview, examples, and download links.
Quick start: open link → choose module → download → import → test.

🆕 Add New Module

Steps to add a new HTML page inside `postman/docs/modules/` and link it to the main page

Create Page

Create a new HTML file inside `postman/docs/modules/` with the same structure as `core.html`

Add Card

Add a new card in `index.html` inside `postman/docs` with link to the new page

Share

Share the final link with the team or add it to Slack/Email using templates above