You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Documentation/how-to-create-postman-collections.md
+13-3Lines changed: 13 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# How to create Postman collections
1
+
# How to create Postman workspaces & collections
2
2
3
3
We use [Postman](https://www.getpostman.com/) heavily at Nodes for tasks like:
4
4
@@ -10,11 +10,21 @@ We use [Postman](https://www.getpostman.com/) heavily at Nodes for tasks like:
10
10
11
11
To align how we work with Postman, this document was created.
12
12
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
+
13
23
## How to setup a new collection
14
24
15
25
### Creating a collection
16
26
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").
18
28
19
29
### Sharing a collection
20
30
@@ -109,4 +119,4 @@ Postman documentation is covered in its own file [here](https://github.com/nodes
109
119
110
120
## How to create API acceptance tests
111
121
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