GithubHelp home page GithubHelp logo

postmanlabs / postman-docs Goto Github PK

View Code? Open in Web Editor NEW
562.0 46.0 600.0 44.38 MB

Documentation for Postman, a collaboration platform for API development. Available for Mac, Windows, and Linux.

Home Page: https://learning.postman.com/

License: Apache License 2.0

JavaScript 97.53% Shell 0.56% CSS 1.62% SCSS 0.29%
postman api documentation github-actions gatsbyjs jamstack

postman-docs's People

Contributors

66eli77 avatar abhijitkane avatar akinard-postman avatar arifpman avatar arlemi avatar brandonmcastillo avatar btwisted avatar ch264 avatar claireriley avatar danielkimmelmann1 avatar godfrzero avatar heatherstenson avatar jerry-li-dev avatar jjgothard avatar jkonrath-postman avatar loopdelicious avatar mark-anthony-postman avatar matthewpinsker-postman avatar mclausaudio avatar nerminamiller-postman avatar numaanashraf avatar olliesworld avatar oswish avatar pamelagilmour avatar petewitcher-postman avatar ryan-mcbride avatar sowmyaraj92 avatar staysea avatar suesmith avatar tristandenyer avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

postman-docs's Issues

Testing with Postman

I want to test my API, that 1 function has many test cases, how can I do this in Postman. Have I write many requests for 1 function?
Ex: I want to test login function, and I write 2 requests, 1 for correct email/password, and 1 for wrong email/password?

Broken links

OP: @loopDelicious postmanlabs/postman-app-support#5271

Customer is reporting a number of 404s throughout the Postman docs, throughout monitoring pages, documentation pages, and probably throughout the rest of the docs

  • 404s
  • also some variables (like email) are not resolving in the new learning center docs - see screenshot
  • also consider running Link Checker collection template to monitor for broken links

screen shot 2018-09-27 at 12 37 17 pm

Optimize search experience in Postman docs

OP: postmanlabs/postman-app-support#5338 by @loopDelicious

Currently there are commonly searched topics that either aren't covered in the Postman docs OR they aren't indexed properly in the search.

Example
When someone searches for jwt in the Postman docs, they see zero results. However, we can add a JSON Web Token (JWT) example under the Bearer Token Auth helper section of the Authorization page, or link to our YouTube video on JWT authorization. Alternatively, just add the text "JWT" in this section, and the section will be indexed in the search. This will point them in the right direction, when they do this search, instead of showing zero results.

We know some of these metrics:

Most popular searches
Search results that return zero results

I gave Arif access to our Algolia team account, so he has access to these search metrics. We can also compare with Google Analytics to see search bounces for when a person lands on a page they weren't expecting.

Issues In New Button docs

https://www.getpostman.com/docs/v6/postman/launching_postman/newbutton

  1. In the first paragraph of Create New section, the first two lines just explain what is in the UI. Let's expand this with a one line summary of these blocks and then link to the relevant sections below for each

In BUILDING BLOCKS, create a new request, collection, or environment.
In ADVANCED, create new documentation, a mock server, or a monitor.

  1. Blocks are incorrectly mentioned as features.

You can also directly create a new feature when you click the down arrow at the right side of the New button.

  1. Highlight or draw attention to the New dropdown in the screenshot below.
    https://s3.amazonaws.com/postman-static-getpostman-com/postman-docs/WS-new-button-menu-blk.png

  2. Update environment screenshot at https://s3.amazonaws.com/postman-static-getpostman-com/postman-docs/WS-manage-environments-newButton.png

Dead links on Managing Your Billing learning center article

Article is here:
https://learning.getpostman.com/docs/postman_pro/managing_postman_pro/managing_your_billing/

Dead Links:

Change your plan (Pro Monthly)
Add user slots to your plan (Pro Annual)
Set instructions for next billing cycle
Set the monitoring block count
Manage your invoices
Cancel your plan

Dead links contain: docs/pro/...
/docs/pro/managing_pro/changing_your_plan

Correct URL is: docs/postman_pro/...
/docs/postman_pro/managing_postman_pro/changing_your_plan

Incorrect links and template rendering in the documentation

The local and data variable scopes are inverted in the variable scopes

In the list of variable scopes and the illustration, the local variables are lower in the hierarchy then data variables. The local variables have the highest precedence among all the variable scopes.

The list should be
Global
Collection
Environment
Data
Local

and same in illustration

Also the local variables are set using pm.variables.set. This is not documented anywhere. Maybe we could just mention it as to what local variables are somewhere in this doc.

Remove {:target="_blank"}

{:target="_blank"} is seen in some of the files due to how the old docs site worked. These aren't needed anymore and are improperly rendered on the Learning Center.

I have started to remove these as I get around to them but if anyone else has the time, please also remove these while working on docs.

Thanks!

URLs for Mock Server articles on Learning Center return 404

Postman collections document generation error

If the first response is 200 and empty body
All the following example response will gone.

Video

https://youtu.be/6CjFMiZ5Tmo

Possible reason

All the response example is in the same html DOM if the first one do not have response. The response DOM will not be created. Therefore, all the following response will not shown.

Document caveats about working with pm.sendRequest response headers

User: I'm having real issues drilling down into a pm.sendRequest response header in a pre-request script. Syntax like res.header[x].value barfs in postman (the value is there, though), while the same JSON object in the browser console is fine. Known issue? #testing

Postman: The response you get in the callback is not a plain javascript object. It is a postman-collection response instance. You can find the API reference here https://t.co/rxLc4yFlo8

The documentation for send request https://t.co/BjbaqrVA1i has more details.

You might want to try this out

pm.sendRequest('http://postman-echo.com', function (err, res) {
  console.log(res.headers.toObject());
});

It doesn’t communicate the caveat with the response type. But it points to the link for the right response type.

Add documentation around how and when to use different variable scopes.

Currently in Postman documentation around variables we do explain different types of variable scopes but do not provide enough context on "when to use which type of scope". With 4 types of scopes users have a lot of confusion around which variable should they use, how to manage them etc.

Changes in Linux installation doc

Page: https://www.getpostman.com/docs/v6/postman/launching_postman/installation_and_updates

  1. Linux installation is not different for different distributions, creating postman.desktop file is common for all supported distributions for us. so specify that it as an extra step to link the app executable.

  2. Desktop entry file needs to specify executable path instead of just the name.

cat  > ~/.local/share/applications/postman.desktop
[Desktop Entry]
Encoding=UTF-8
Name=Postman
Exec=<Your_Install_Dir>/Postman/app/Postman
Icon=<Your_Install_Dir>/Postman/app/resources/app/assets/icon.png
Terminal=false
Type=Application
Categories=Development;

Recommend using env/global/collection variables than path variables

We should not recommend people to use path variables, instead, they should be using environment, collection or global variables. I don't see a use case where new users should be using path variables.

But, in our docs, even the core concepts like sending a request is teaching people how they can use path variables.

We can talk about briefly variables in general there and link to the variables docs. In the variables docs we can talk about path variables and then recommend to use other variables also explaining the reasons.

Here's a link to a issue on our community where a new user started using path variables after checking the docs.
https://community.getpostman.com/t/advantage-of-path-variables-over-environment-or-global-variables/2697/3

Some past issues with path variables

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.