Documents
Design documents in Insomnia
Design documents (also called documents) hold API specifications, API requests, and tests.
Documents have three main capabilities:
- Design: Create or upload API specs. Lint your specs for errors.
- Debug: Generate a collection from your API spec. Debug requests and responses.
- Test: Create a test suite for requests in your collection.
Design APIs
The interactive API spec renderer lets you develop and refine your API spec in the same environment where you’ll test it.
- Built for spec-first development
- View a generated preview of your spec in Insomnia
- Automatic linting, with the ability to write custom linting rules
- View the errors console
- Automatically parse and categorize data from your API spec such as server request body, and schemas
Frequently asked questions
What’s the difference between a collection and a design document?
Documents are a data object that can contain an API spec, a collection of API requests, and tests. Collections are simply a series of API requests that you intend to interact with Insomnia.
Does Insomnia support GraphQL?
Yes, Insomnia supports GraphQL.