Design Documents

Design Documents are a way to group and share API specifications, requests and unit tests within Insomnia. For working with collections, see Request Collections.

You can create, delete, and switch between Design Documents and Request Collections from the Dashboard, accessed from the upper left-hand corner of the application.

Creating a new Design Document

  1. Go to the Dashboard
  2. Click "Create" button in upper right hand corner
  3. Select "New Design Document" or a method of importing a
  4. Select how you would like to create a new document.

Note: when naming your document, the name selected will be displayed on the Dashboard. Spaces and special characters are allowed. 🤗

Renaming a Design Document

  1. Go to the Dashboard
  2. Open the action menu (visualized by the three dots) on the document you wish to rename.
  3. Select "Rename" action

Rename the document

Deleting a Design Document

  1. Go to the Dashboard
  2. Open the action menu (visualized by the three dots) on the document you wish to rename.
  3. Select the "Delete" action

Follow the steps to delete the document

Editing a Design Document

  1. Go to the Dashboard
  2. Click on the document you wish to edit

You will now be presented with the Editor Mode, and a Preview Pane will display the rendered results of the document you are currently editing.

Going Back to the Dashboard

  • Click on the "Dashboard" link in the upper left hand corner to get back to the Dashboard