Skip to content

Commit 6de42df

Browse files
Merge pull request ml-archive#95 from nodes-vapor/feature/include-workspaces
Update how-to-create-postman-collections.md
2 parents f79b51f + 7ddaf33 commit 6de42df

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

Documentation/how-to-create-postman-collections.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# How to create Postman collections
1+
# How to create Postman workspaces & collections
22

33
We use [Postman](https://www.getpostman.com/) heavily at Nodes for tasks like:
44

@@ -10,11 +10,21 @@ We use [Postman](https://www.getpostman.com/) heavily at Nodes for tasks like:
1010

1111
To align how we work with Postman, this document was created.
1212

13+
## How to set up a new workspace
14+
15+
Each project at Nodes that contains an API should have a workspace. A workspace can hold internal API collections, external API collections and any test collections. The workspace should have the same name as the project on GitHub but without the framework suffix. See [this document](https://github.com/nodes-projects/readme/blob/master/general/new-repository.md) for more info on our repo naming convention (internal link).
16+
17+
Remember when creating a workspace that it's created on the Nodes Team instead of your personal account.
18+
19+
### Structure of a workspace
20+
21+
Use collections within the workspace to group related endpoints. Normally we would have one collection for the API that the mobile applications will consume and then a number of extra collections based on the specifics of the project. These could be collections for external API's that the backend uses or test collections.
22+
1323
## How to setup a new collection
1424

1525
### Creating a collection
1626

17-
Each project at Nodes that contains an API should have a corresponding Postman collection. A collection can be considered as a project or simply a folder in Postman. The collection should have the same name as the project on GitHub but without the framework suffix. See [this document](https://github.com/nodes-projects/readme/blob/master/general/new-repository.md) for more info on our repo naming convention (internal link).
27+
Collections are groups of endpoints and using them is a great way to keep a structure within your API project. Remember to create the relevant collections within the correct project-specific workspace (instead of the fallback "Team Workspace").
1828

1929
### Sharing a collection
2030

@@ -109,4 +119,4 @@ Postman documentation is covered in its own file [here](https://github.com/nodes
109119

110120
## How to create API acceptance tests
111121

112-
Postman API acceptance testing is convered in its own file [here](https://github.com/nodes-vapor/readme/blob/master/Documentation/how-to-create-postman-tests.md).
122+
Postman API acceptance testing is covered in its own file [here](https://github.com/nodes-vapor/readme/blob/master/Documentation/how-to-create-postman-tests.md).

0 commit comments

Comments
 (0)