Style Guide
Workspace Organization
As a general rule of thumb, we have a workspace in postman for every git repository.
Organizing workspaces in this way...
- keeps the number of collections and environments in check, and thus easier for us to find what we are looking for
- makes it much easier to quickly understand which environments are compatible with a given collection
Environment Variables
Camel Casing
We use camel casing for naming environment variables. For example, baseUrl
rather than BaseUrl
, or base-url
.
Name Standardization
Some environment variables will likely be used across several different workspaces and collections. For this reason, we want to have consistent names for certain variables. For example, for the domain of a given API we could name a variable several different things that are all great names like domain
, origin
, or baseUrl
, but having a standardized name we use across all collections will help eliminate the need to figure out what the name is used in a particular collection or environment.