Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Tutorial] Postman Installation and Usage #299

Open
wants to merge 17 commits into
base: master
Choose a base branch
from

Conversation

ChrisDanielW
Copy link

What type of PR is this?
/kind documentation

What this PR does / why we need it:
Integrates a SODA tutorial into the SODA documentation

Which issue(s) this PR fixes:
Fixes #

Test Report Added?:
/kind tested

Test Report:

Special notes for your reviewer:

@anvithks

Copy link
Member

@anvithks anvithks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please check the review comments.
@ChrisDanielW @ichiragkumar @ASHAE847 @hackerlakshmi


<br>
<br>

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good starting point @ChrisDanielW @ichiragkumar @ASHAE847 @hackerlakshmi

Please add some documentation on:

  • Global variables and how to use them
  • Environments, environment variables and how to use them
  • Creating collections and running collections.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay

![](https://i.imgur.com/ZapU4PC.png)

<br>
Provided you followed all the above steps properly, you have now successfully used Postman to get a postive response from an API.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding some basic API end point as examples and sample responses.
Add one sample API and example response for each:

  • GET
  • POST
  • UPDATE
  • DELETE

You can use any publicly available API server for the same.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Understood

@ChrisDanielW ChrisDanielW changed the title [Tutorial] Postman Installation and Usage [WIP] [Tutorial] Postman Installation and Usage Apr 13, 2023
@ChrisDanielW ChrisDanielW changed the title [WIP] [Tutorial] Postman Installation and Usage [Pending review] [Tutorial] Postman Installation and Usage Apr 26, 2023
@ChrisDanielW ChrisDanielW changed the title [Pending review] [Tutorial] Postman Installation and Usage [Tutorial] Postman Installation and Usage Apr 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants