API Documentation

What is API Documentation?

Create API documentation with Postman

Use the Postman API documentation feature to generate beautiful, machine-readable documentation for your API and keep it automatically updated.

Quickly create custom API documentation

Postman lets you publish documentation quickly and easily. Postman automatically pulls your sample requests, headers, code snippets, and more to populate your documentation page with dynamic examples and machine-readable instructions, so you can easily share your API with the rest of the world.

Create reliable, shareable, and easy-to-follow documentation with Postman

• Automatically update your documentation
• Never leave the documentation behind the service again. Postman automatically updates your documentation every time you make changes to your collection - in real time.
• Easily share with the "Run" button on Postman
• Share your collection in seconds. Embed the "Run on Postman" button on your documentation page or any other site to allow anyone to import your collection with one click.
• Earn your API adoption
• If you use APIs, you know the importance of documentation for communicating instructions for use. The Postman documentation is machine-readable, so anyone - developers, testers, product managers, or partners - can directly consume your API through the Postman instance.
• Collaborate with your team in Documents
• Postman's feedback feature allows you and your team to share feedback through comments and code reviews. You can easily organize and notify your teammates about changes or errors so that you can present the best possible documentation to your users.

Introduction to documentation

Create dynamic documentation easily, quickly, and continuously with the Postman API documentation generator.

The Postman API documentation feature allows you to view private API documentation or share public API documentation on a beautifully formatted Web page. Postman automatically generates and hosts browser-based API documentation for your collections in real time. Each collection has a preview of public and private documentation that Postman generates from synchronized data on the servers.

Simplify API development with Postman

More than 8 million users and 300,000 companies use Postman, making Postman the most popular API development platform in the world. Manage your APIs easily with the only full API development environment.

System requirements:

OSX (x64) / Windows (x86 or x64) / Linux (x86 ou x64).