Postman Collection

A real Postman collection generated from the NestJS controllers and DTOs in apps/api — generated straight from the live OpenAPI spec apps/api serves, 21 folders, 85 requests, matching the routes and request bodies QA stories in the API section reference.

Download buyootna-api.postman_collection.json

Setup

  1. 1

    Download the collection

    Click the download button above, or grab it directly from the running docs site at /buyootna-api.postman_collection.json.

  2. 2

    Import into Postman

    Postman → Import → File → select the downloaded .json. It creates a "Buyootna API" collection with 21 folders covering every controller in apps/api.

  3. 3

    Set collection variables

    Open the collection's Variables tab and set baseUrl (e.g. http://localhost:8000 for local, or the api.buyootna.cloud origin for staging/prod).

  4. 4

    Get an access token

    Run Auth → Login with a real identifier/password. Copy the JWT from the response into the accessToken collection variable — every other request inherits Bearer auth from it automatically.

  5. 5

    Fill in path variables as you go

    Requests with a URL segment like :propertyId or :reviewId show it in Postman's Path Variables tab, per request — fill it in from whatever record you're currently testing against.

Always in sync: the collection is generated from the live OpenAPI spec apps/api serves (apps/web/docs/scripts/generate-postman-collection.mjs), not hand-maintained — it reflects the real controllers/DTOs automatically. Start the API dev server, then re-run node scripts/generate-postman-collection.mjs any time you want a fresh copy of the downloadable file.