Launching Live Preview for OpenAPI Specification editing
We are thrilled to announce the launch of a new feature that will enable you to write OpenAPI Specifications better: Live Preview. With Live Preview, you can now get a real-time view of your API documentation right as you make changes, empowering you to create accurate and visually appealing specifications effortlessly.
What is Live Preview?
Live Preview integrates into our API Builder OpenAPI Schema authoring experience. You don’t need to constantly switch tabs or save and refresh documents to check how your changes affect the final output. With Live Preview, what you see is truly what you get.
Why use Live Preview?
No more guesswork! As soon as you modify your OpenAPI Specification, whether it’s endpoints or parameters, the corresponding documentation instantly updates in real time. This allows developers and technical writers to have immediate feedback on how their changes impact the overall structure and content.
By having instant visibility into the results of your edits before committing them permanently, it’s now easier than ever to identify errors or inconsistencies early on. Catching mistakes during development saves valuable time later when you’re troubleshooting issues arising from inaccurate or incomplete specifications.
How does it work?
Using this new feature couldn’t be simpler! Just open your desired OpenAPI Specification within the API Builder:
Make any changes required using our intuitive editor.
Simultaneously monitor the live preview panel located next to your editing pane in the context menu.
Visualize exactly how each modification affects elements such as headers, request bodies, response examples, and more.
No need to worry about on-screen editing space; use the full-screen view to maximize the editing and the Live Preview panes while minimizing everything else.
That’s it! With a single glance, you can ensure that your OpenAPI Specification is accurate, visually appealing, and ready for prime time:
Get started with Live Preview today
Live Preview is available to all users of the Postman API Platform. Simply log in or create an account to take advantage of this powerful feature. Whether you’re a developer looking to streamline the documentation process or a technical writer aiming to improve efficiency and collaboration, Live Preview has got you covered.