https://github.com/gadiim/postman-newman-ghactions
https://github.com/gadiim/postman-newman-ghactions
gh-actions newman newman-reporter-htmlextra postman template-project
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/gadiim/postman-newman-ghactions
- Owner: gadiim
- Created: 2024-10-19T17:44:28.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-10-29T13:16:08.000Z (7 months ago)
- Last Synced: 2025-02-13T01:49:56.859Z (3 months ago)
- Topics: gh-actions, newman, newman-reporter-htmlextra, postman, template-project
- Language: HTML
- Homepage:
- Size: 1.08 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Postman + newman + github actions (Simple store template)
## Task steps / First task
1. Read:
- Postman & Curl & REST article
- Postman tests examples (off doc)
- Manual schema generation
2. Download this repo.
3. Run `npm i` (install node.js dependencies)
4. Run `npm run tern-on-api`(to run testing server locally )
### Overview of local server testing
Routes `/products`, `/orders` and `/users`. Below is a table of supported operations with `products` as example resource. The same operations are also supports for `orders/` and `users/`.
| VERB |Route | Input | Output |
|----------|---------------|------------|--------------------|
| GET | /products | *None* | **Array** |
| GET | /products/:id | **e.g 3** | **Object** |
| POST | /products | **object** | **Created object** |
| PUT | /products | **object** | **Updated object** |
| DELETE | /products/:id | **e.g 3** | **Deleted object** |
5. Upload `store.collection.json` in Postman app. (skip this exhibit in case you decide to use another public API )
6. Make some integration tests in Postman, could be status code/JSON check and so on. ( in case with another API - write tests based on another one).
Examples:
- Test pagination, by way like `http://localhost:3000/users?page=1&pageSize=2`.
- Test sorting, by way like `http://localhost:3000/users?sortOrder=ASC&sortKey=firstName`. You can sort an any resource response using query parameters sortOrder and sortKey.
- Test status code for REST API (200,400 and so on).
- Test response time.
- Test response thanks to json schema validation.
- Try to follow `AAA` approach (arrange, act, assert).
7. Save new collection with your new integration tests with the same name as `store.collection.json`. ( in case with another API - another file name for json file)
8. Push to you github repo in main branch ( in case with local server - save local server as well )
### GH actions practice / Second Task
9. Add Github action to run `petstore.collection.json` in Github pages by article or use another GH action.
10. Check github actions for result.
You can use another API to perform your testing instead of local store API and `store.collection.json`.
- Public API list
### Usefull links (skip this)
Examples with different actions in Postman workspace (only take a look once, no need to learn this)
- Postman answers
- REST API Tutorial
Doc for json schema validation, to check output API response (only take a look once, no need to learn this doc)
- json schema docs