How to test and document an API without ever leaving the editor

The Problem: Tool-Switching Wrecks API Workflows

Managing APIs across multiple tools is a productivity killer. You’re stuck juggling Postman (or any of its lookalike clones) for tests, a browser for endpoint checks, and a platform like Confluence or Notion for docs. The result? A fragmented, frustrating workflow:

Here’s a scenario: Mid-sprint, you’re debugging an API. Postman shows a 200, but the docs aren’t really up to date; they list an old endpoint version. You go to the codebase, find a new response schema, and now that everything is sorted out, the Postman cloud hangs, forcing you to re-run tests. Time wasted chasing inconsistencies and retyping docs. Mouse clicking, tabbing, jumping between tools, and figuring out why things aren’t the same across the board - all checked. A remotely optimal dev experience, nowhere to be found.

This fragmented approach doesn’t just waste time. It introduces errors as well.

Disconnected tools mean manual updates, leading to outdated documentation that confuses teams and stakeholders. Postman’s cloud-based collections, for instance, live outside your codebase, forcing you to export and sync manually, which disrupts your workflow. Tools used for general documentation usually lack the native integration with your repo needed for seamless API development. The constant context-switching between tools slows down collaboration and makes it harder (impossible, really) to maintain a single source of truth for your APIs.

Voiden’s Approach: Markdown-Powered API Workflow

Voiden eliminates these pain points by allowing you to define, test, and document APIs in Markdown-style .void files, all in its offline editor. Specs live in your repo, versioned with Git, with live API responses for docs that stay accurate. No tool-switching or cloud syncs. Teams using Voiden report are halving their API documentation time, keeping specs in sync with code which saves even more time in the future.

.void files are designed to be lightweight and intuitive, combining API specifications, tests, and documentation in a single, human-readable format. Using Markdown’s simplicity, you can define endpoints, write test cases, and embed live response data directly in the editor.

For example, a .void file might include a POST request definition, a test to validate the response status, and inline documentation, imported headers for element reusability and following the DRY principle, all sitting together. Because these files are stored in your filebase, they are Git-friendly, every change is easily versioned, trackable, and reviewable through pull requests, just like your code. This approach ensures your API specs and docs are always in sync with your codebase, reducing errors and eliminating the need for external platforms. Plus, Voiden’s offline-first design means you can work anywhere, even without an internet connection (well, for docs and localhost testing), with no safety issues, or an account.

Here’s an example of Voiden usage:

Getting Started

Want to test and document APIs without the tool-switching grind? Start with Voiden:

• Download the offline app from voiden.md and set up an API repo.

• Create your .void file.

• Run tests in Voiden’s editor, validate responses, and add docs with live results.

• Document one API endpoint and commit it to Git for a PR review.

To make the transition even smoother, Voiden supports importing existing Postman collections with a single click, converting them into .void files that integrate seamlessly into your repo. This eliminates the hassle of rewriting specs from scratch. Read more about migrating your Postman collections here. Join our GitHub Discussions to share feedback and shape Voiden.