Postman Collection Structure and Naming Plan for an API
Organise requests so they can be found, shared and tested.
The Open buttons send the prompt text as currently shown below to that site only when you click. Fill in the placeholders first.
[VERIFY] is an editorial flag, not a blank to fill. Wherever the prompt shows [VERIFY], check that item against a reliable source before you use it.
Plan a Postman collection for an API. API purpose and main resources: [RESOURCES]. Authentication method (type only, never secrets): [AUTH_TYPE]. Environments (local, staging, production): [ENVIRONMENTS]. Team members who use the collection: [USERS]. Show the folder tree as an indented outline for an invented order API (Auth, Customers: list, create, get, update; Orders: list, create, get, cancel; Payments; Admin) and name requests with the pattern METHOD resource action, for example GET Orders - list recent. Define variables (collection, environment, global) with names and purposes, and explain collection-level scripts and variables for things like the base address and common headers [VERIFY], plus the danger of hidden logic that surprises new users. Write the description template for each request (purpose, parameters, expected responses, notes) with a filled example, a style guide using fake data only, and collection-level documentation (how to authenticate, environments, rate limits, changelog). Include a sample set of requests for one resource and a sample environment file with placeholders only. Keep secrets in environment variables marked secret, not in the collection or shared exports [VERIFY]. Pre-share checklist: no tokens, no real customer data, descriptions complete, tests present. Add a review route for changes and a version number in the collection description. Another developer should be able to run the collection from the description alone, and no real credentials appear anywhere.
Fill in before use
Optional: type your details and the prompt above updates. Nothing is saved or sent.
Replace each bracketed placeholder with your own details, then paste into Any AI or another assistant.
See an example result (fictional data)
Invented tree for an orders API. Folders: Auth (POST Token), Customers (GET list, POST create, GET by id), Orders (GET list recent, POST create, GET by id, POST cancel), Payments (POST pay). Variables: base_url (environment), token (secret environment variable), customer_id (set by a test script). Example request description: 'GET Orders - list recent. Returns the 20 most recent orders for the signed-in customer. Parameters: limit (1 to 100). Expected: 200 and a list.' Pre-share checklist: no tokens in examples, descriptions complete, tests present, environment template contains placeholders only.
Illustrative only, made-up data. Your results will differ and must be reviewed.