Skip to content

Latest commit

 

History

History
73 lines (50 loc) · 3.8 KB

part3-Liftoff.md

File metadata and controls

73 lines (50 loc) · 3.8 KB

Liftoff- part 3

[DO] Run the collection with the collection runner

  1. Import the Postman Echo template.
  2. Run the collection with the collection runner, and observe the results.
  3. Filter on failed tests, and drill down into the request and response details.

[OBSERVE] Run the collection from CLI with Newman

  1. In order to use Newman, you will need to install Node.js, a package manager like npm, and Newman using a command like npm install -g newman.
  2. Export the Postman Echo collection to a local directory, run the collection, and observe the CLI output.
newman run collection.json

[OBSERVE] Run the collection from CLI with Newman and Postman API

  1. Import Postman collection from the API Network.
  2. Retrieve your Postman API key, and store it as an environment variable called postman_api_key.
  3. GET all collections, find the Postman Echo collection in the response body, and copy the collection uid to your clipboard.
  4. GET a single collection using the uid from the previous step.
  5. In order to use the URL with Newman, add a query string parameter apikey with the value of your Postman API Key.
  6. Run the collection using Newman and this entire URL, and discuss how this can be used with your Continuous Integration / Continuous Delivery (CI/CD) pipeline.
newman run https://api.getpostman.com/collections/{{collection_uid}}?apikey={{postman_api_key}}

[DO] Run the collection from Postman servers with Monitor

  1. Schedule a monitor to run on the Postman servers, select the frequency, regions, and other configuration options.
  2. In the web dashboard, review the monitor run results.

[DO] Do documentation

  1. Write a description in markdown for a collection, folder, request, and parameter.
  2. Create a team workspace, and share an existing collection to the new workspace.
  3. Publish the collection publicly, customize theme, and add as a template.

[DO] Collaboration

  1. Toggle over to the Browse view in Postman.
  2. For Postman Team users, update the role of a user for a collection in a team workspace.
  3. Fork and merge a collection
  4. Add a new version to the API specification (or to the collection).
  5. Review the changelog for the collection. Review the activity feed for a workspace, user, or team (if team exists).
  6. Browse available integrations.

winter solstice art

Summary

  1. Running a collection with Newman for CI/CD, from CLI, or as a library
  2. Running a collection with monitors from Postman servers
  3. Writing and sharing private and public documentation
  4. Using Postman for lots and lots of collaboration

Concepts

  1. Automation with Newman and Monitors
  2. Documentation
  3. Collaboration

Additional resources

  1. Postman Echo template
  2. Postman API

Next

Continue to Part 4: Activate Thrusters