API Documentation | The Exploratory

Explore how to document your APIs in Postman.

Bitcoin tracker code sample

0:00 Intro to API documentation in Postman
0:30 Import API specification file
0:50 View documentation in a tab in Postman
1:45 Code samples to replicate API calls
2:52 Add descriptions formatted in Markdown
3:33 Describe scenarios with example request and response
4:00 Include a Get Started collection, folder, or section
4:30 Control access in personal, team, or public workspace
5:13 Publish documentation to the web
6:33 View documentation in the web
7:20 Explore the Public API Network

Good Documentation Checklist

Read about it in the docs

Refer to an older version of Postman

[AbderrahmanFodili]

the amount of learning I was missing out on . so many examples of docs and APIs right in front of me in postman

[vaishnavinaik]

Just getting started on documenting on Postman. Super helpful. Thanks! :)

[jeevanmandal]

You have explained very well to understand the API Documentation. Thanks for your Video!!

[tabahbaridule]

This is great, thanks for helping out.

[kurniamassidik]

thanks for your video, really helpful to me

[nunzioaltamura]

Amazing video! Very helpful, super clever!

[jpsusini]

Thank you verymuch, it was very usefull to me perfect explanation ))

[SP-cxoq]

How to describe the response fields? Can I add the comments into the example of response or how to describe it?

[sakhile]

Can I save this documentation as a pdf ?

[prabhadharmalingam]

How will do the same for gRPC services ?

[pawelduda]

Can you publish the docs only for my team and organisation?

[william]

She looks so much like the Silicon Valley S4 character